lazarus/docs/xml
dsiders 0c69d72456 Docs: LCL/valedit. Fixes awkward wording in the TValueListEditor.FixedCols topic.
(cherry picked from commit 0a773a82e44596452853717549abcfe97f8fa752)
(cherry picked from commit c29e9d7815)
2025-04-18 22:17:17 -04:00
..
freetype Docs: FreeType. Updates external references (uses) for changes in 733ac0ed. 2024-10-21 20:57:36 +01:00
ide
lazutils Docs: LazUtils/lazutf8. Updates UTF8Copy and UTF8Insert topics for changes in 162cbbfc, 913b749f, bad60c01. 2025-04-16 16:46:05 +03:00
lcl Docs: LCL/valedit. Fixes awkward wording in the TValueListEditor.FixedCols topic. 2025-04-18 22:17:17 -04: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