mirror of
https://gitlab.com/freepascal.org/lazarus/lazarus.git
synced 2025-04-05 05:48:12 +02:00
59523cede0
* Use FPDoc 3.3.1 by default. * Adds log file output to all variations of the command line. * Comments on use of --footer-date argument. FPDoc 3.3.1 raises an AV as of 2024-03-01. * Adds comments about content that needs to be updated before running the scripts. * Changes the default content in the --footer text variant.
37 lines
1.8 KiB
Bash
Executable File
37 lines
1.8 KiB
Bash
Executable File
#!/bin/bash
|
|
|
|
# Builds Lazarus documentation for LCL and LazUtils in CHM format.
|
|
# Requires a $(LazarusDir)/docs/chm directory which contains rtl.xct and fcl.xct.
|
|
# Process fails if either the directory or the files are missing.
|
|
# Process creates ./lcl and ./lazutils subdirectories for CHM output.
|
|
# UPDATE THE CONTENT IN LOCALLCLFOOTER.XML IF NEEDED BEFORE STARTING THE SCRIPT.
|
|
|
|
# Path to the fpdoc program
|
|
# The trunk (main) version of fpdoc is recommended.
|
|
# CHANGE THIS TO A PATH VALID FOR YOUR SYSTEM AND FPDOC VERSION.
|
|
#fpdocpath="../../fpc/3.2.2/bin/x86_64-win64"
|
|
fpdocpath="../../../fpc331/fpc/bin/x86_64-win64"
|
|
|
|
# rebuild if needed
|
|
#../../lazbuild build_lcl_docs.lpi
|
|
|
|
# build chm output WITHOUT footers
|
|
#./build_lcl_docs --outfmt=chm --fpcdocs=../chm --fpdoc=$fpdocpath/fpdoc 2>&1 | tee -a ./build_chm.log
|
|
|
|
# build chm output with date in footer
|
|
# DOES NOT WORK IN FPDOC 3.3.1 AS OF 2024-03-01 (AV)
|
|
#./build_lcl_docs --outfmt=chm --fpcdocs=../chm --fpdoc=$fpdocpath/fpdoc --arg "--footer-date" 2>&1 | tee -a ./build_chm.log
|
|
|
|
# For FPDoc 3.2.X: build chm output with footers in locallclfooter.xml
|
|
# update the content in locallclfooter.xml if needed before starting the script.
|
|
#./build_lcl_docs --outfmt=chm --fpcdocs=../chm --fpdoc=$fpdocpath/fpdoc --footer=locallclfooter.xml 2>&1 | tee -a ./build_chm.log
|
|
|
|
# For FPDoc 3.3.X: build chm output with footers in locallclfooter.xml
|
|
# update the content in locallclfooter.xml if needed before starting the script.
|
|
#./build_lcl_docs --outfmt=chm --fpcdocs=../chm --fpdoc=$fpdocpath/fpdoc --footer=@locallclfooter.xml 2>&1 | tee -a ./build_chm.log
|
|
|
|
# For FPDoc 3.3.X ONLY: build chm output with footer text
|
|
# update the text in ftr before starting the script
|
|
ftr="Version 3.4 (YYYY-MM-DD)"
|
|
./build_lcl_docs --outfmt=chm --fpcdocs=../chm --fpdoc=$fpdocpath/fpdoc --footer="$ftr" 2>&1 | tee -a ./build_chm.log
|