paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-08-31 10:20:40 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: build_lcl_docs: --footer

Browse Source 
git-svn-id: branches/fixes_1_8@55170 -
This commit is contained in:
mattias 2017-06-02 20:43:25 +00:00
parent 98f72124f0
commit 4ff4670289
2 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/html/build_lcl_docs.lpr
View File

@ -22,7 +22,7 @@ var
DefaultXCTDir: String; DefaultXCTDir: String;
DefaultFPDocParams: string = ''; DefaultFPDocParams: string = '';
DefaultOutFormat: string = 'html'; DefaultOutFormat: string = 'html';
DefaultFooterFilename: string; // ToDo DefaultFooterFilename: string = 'locallclfooter.xml'; // ToDo
type type
TFPDocRunStep = ( TFPDocRunStep = (
@ -84,7 +84,7 @@ type
procedure Execute; procedure Execute;
property Options: TFPDocRunOptions read FOptions write FOptions default DefaultFPDocRunOptions; property Options: TFPDocRunOptions read FOptions write FOptions default DefaultFPDocRunOptions;
property CSSFile: String read FCSSFile write SetCSSFile; 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 FPDocExe: String read FFPDocExe write FFPDocExe;
property IncludePath: string read FIncludePath write SetIncludePath;// semicolon separated search path property IncludePath: string read FIncludePath write SetIncludePath;// semicolon separated search path
property InputFile: string read FInputFile write SetInputFile; // relative to OutDir, automatically created property InputFile: string read FInputFile write SetInputFile; // relative to OutDir, automatically created
@ -124,6 +124,7 @@ begin
WriteLn(' --fpcdocs <value> The directory that contains the required .xct files.'); WriteLn(' --fpcdocs <value> The directory that contains the required .xct files.');
WriteLn(' Use this to make help that contains links to rtl and fcl'); WriteLn(' Use this to make help that contains links to rtl and fcl');
WriteLn(' --footer <value> Filename of a file to use a footer used in the generated pages.'); WriteLn(' --footer <value> Filename of a file to use a footer used in the generated pages.');
WriteLn(' Default is "'+DefaultFooterFilename+'"');
WriteLn(' --help Show this message'); WriteLn(' --help Show this message');
WriteLn(' --arg <value> Passes value to fpdoc as an arg. Use this option as'); WriteLn(' --arg <value> Passes value to fpdoc as an arg. Use this option as');
WriteLn(' many times as needed.'); WriteLn(' many times as needed.');
@ -197,7 +198,7 @@ begin
GetEnvDef(DefaultOutFormat, DefaultOutFormat, 'FPDOCFORMAT'); GetEnvDef(DefaultOutFormat, DefaultOutFormat, 'FPDOCFORMAT');
GetEnvDef(EnvParams, '', 'FPDOCPARAMS'); GetEnvDef(EnvParams, '', 'FPDOCPARAMS');
GetEnvDef(DefaultFPDocExe, DefaultFPDocExe, 'FPDOC'); GetEnvDef(DefaultFPDocExe, DefaultFPDocExe, 'FPDOC');
GetEnvDef(DefaultFooterFilename, '', 'FPDOCFOOTER'); GetEnvDef(DefaultFooterFilename, DefaultFooterFilename, 'FPDOCFOOTER');
GetEnvDef(DefaultXCTDir, DefaultXCTDir, 'FPCDOCS'); GetEnvDef(DefaultXCTDir, DefaultXCTDir, 'FPCDOCS');
if DefaultOutFormat = '' then if DefaultOutFormat = '' then
@ -346,6 +347,9 @@ begin
Params.Add('--css-file='+ExtractFileName(CSSFile)); // the css file is copied to the OutDir Params.Add('--css-file='+ExtractFileName(CSSFile)); // the css file is copied to the OutDir
end; end;
if (FooterFilename<>'') and FileExistsUTF8(FooterFilename) then
Params.Add('--footer='+FooterFilename);
if EnvParams<>'' then if EnvParams<>'' then
SplitCmdLineParams(EnvParams,Params); SplitCmdLineParams(EnvParams,Params);

1
docs/xml/updateXML.bat
View File

@ -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 Call makeskel for the given LCL module <%1> . <%2>
rem PATH=\repos\fpc-2.5.trunk\utils\fpdoc 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 makeskel --package=lcl --input="..\..\lcl\%1.%2 -Fi..\..\lcl\include" --descr=lcl\%1.xml --update --output=lcl\%1.upd.xml