From 4ff46702898cb0590761dad9956ea96554fcda73 Mon Sep 17 00:00:00 2001 From: mattias Date: Fri, 2 Jun 2017 20:43:25 +0000 Subject: [PATCH] docs: build_lcl_docs: --footer git-svn-id: branches/fixes_1_8@55170 - --- docs/html/build_lcl_docs.lpr | 10 +++++++--- docs/xml/updateXML.bat | 1 + 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/html/build_lcl_docs.lpr b/docs/html/build_lcl_docs.lpr index 3cea64e368..0ef0e13875 100644 --- a/docs/html/build_lcl_docs.lpr +++ b/docs/html/build_lcl_docs.lpr @@ -22,7 +22,7 @@ var DefaultXCTDir: String; DefaultFPDocParams: string = ''; DefaultOutFormat: string = 'html'; - DefaultFooterFilename: string; // ToDo + DefaultFooterFilename: string = 'locallclfooter.xml'; // ToDo type TFPDocRunStep = ( @@ -84,7 +84,7 @@ type procedure Execute; property Options: TFPDocRunOptions read FOptions write FOptions default DefaultFPDocRunOptions; property CSSFile: String read FCSSFile write SetCSSFile; - property FooterFilename: String read FFooterFilename write SetFooterFilename; // ToDo + property FooterFilename: String read FFooterFilename write SetFooterFilename; property FPDocExe: String read FFPDocExe write FFPDocExe; property IncludePath: string read FIncludePath write SetIncludePath;// semicolon separated search path property InputFile: string read FInputFile write SetInputFile; // relative to OutDir, automatically created @@ -124,6 +124,7 @@ begin WriteLn(' --fpcdocs The directory that contains the required .xct files.'); WriteLn(' Use this to make help that contains links to rtl and fcl'); WriteLn(' --footer Filename of a file to use a footer used in the generated pages.'); + WriteLn(' Default is "'+DefaultFooterFilename+'"'); WriteLn(' --help Show this message'); WriteLn(' --arg Passes value to fpdoc as an arg. Use this option as'); WriteLn(' many times as needed.'); @@ -197,7 +198,7 @@ begin GetEnvDef(DefaultOutFormat, DefaultOutFormat, 'FPDOCFORMAT'); GetEnvDef(EnvParams, '', 'FPDOCPARAMS'); GetEnvDef(DefaultFPDocExe, DefaultFPDocExe, 'FPDOC'); - GetEnvDef(DefaultFooterFilename, '', 'FPDOCFOOTER'); + GetEnvDef(DefaultFooterFilename, DefaultFooterFilename, 'FPDOCFOOTER'); GetEnvDef(DefaultXCTDir, DefaultXCTDir, 'FPCDOCS'); if DefaultOutFormat = '' then @@ -346,6 +347,9 @@ begin Params.Add('--css-file='+ExtractFileName(CSSFile)); // the css file is copied to the OutDir end; + if (FooterFilename<>'') and FileExistsUTF8(FooterFilename) then + Params.Add('--footer='+FooterFilename); + if EnvParams<>'' then SplitCmdLineParams(EnvParams,Params); diff --git a/docs/xml/updateXML.bat b/docs/xml/updateXML.bat index 5010d6d1ef..9afb48097e 100644 --- a/docs/xml/updateXML.bat +++ b/docs/xml/updateXML.bat @@ -1,3 +1,4 @@ +rem BEWARE: makeskel 3.1.1 cannot update ndoes. The --update flag is ignored and always creates all nodes. rem Call makeskel for the given LCL module <%1> . <%2> rem PATH=\repos\fpc-2.5.trunk\utils\fpdoc makeskel --package=lcl --input="..\..\lcl\%1.%2 -Fi..\..\lcl\include" --descr=lcl\%1.xml --update --output=lcl\%1.upd.xml