lazarus/docs/xml
dsiders 5edce0a45d Revert "Docs: LCL/controls. Adds control message topics for changes in 9ae59e2b."
This reverts commit 1676d6532c8de484333b33923554a9c1130e0084.
2024-10-20 01:58:06 +01:00
..
freetype Docs: LazFreeType/various. Standardizes tagging for file names in unit overview topics. 2023-05-10 08:54:36 +01:00
ide
lazutils Docs: LazUtils/lazutf8. Updates the UTF8WrapText for changes in 4f8f408f. 2024-10-20 01:58:06 +01:00
lcl Revert "Docs: LCL/controls. Adds control message topics for changes in 9ae59e2b." 2024-10-20 01:58:06 +01:00
mkhtml.bat
multi_makeskel.pl
README.txt
StyleGuide.txt
updateXML.bat

These are the fpdoc xml files of the lazarus units.

The lcl directory contains the fpdoc xml files for the lcl. For example
lcl/controls.xml for controls.pp.

You can create new entries with the fpdoc editor of the IDE (View / FPDoc Editor).

--------------------------------------------------------------------------------
You can create xml files for new units with the IDE fpdoc editor or with:
perl multi_makeskel.pl -p lcl -s ../../lcl -o lcl \
  -i '-Fi/path/to/lazarus/lcl/include' -x
  
At the moment the fpdoc tool 'makeskel' is not yet capable of updating the
files.

--------------------------------------------------------------------------------
If you don't have perl installed, you can use the following command to update
lcl/forms.xml file:

makeskel --update --package=lcl --input="..\..\lcl\forms.pp" --descr=lcl\forms.xml --output=lcl\forms.xml.new

To create a new file use:
makeskel --package=lcl --input="..\..\lcl\forms.pp" --output=lcl\forms.xml

See also: StyleGuide.txt

--------------------------------------------------------------------------------
Examples for gtk interface:

Creation:
perl multi_makeskel.pl -p lclgtk -s ../../lcl/interfaces/gtk \
  -o lcl/interfaces/gtk -i '-Fi/path/to/lazarus/lcl/interfaces/gtk' -x