lazarus/docs/xml
dsiders fa49d60634 Docs: LCL/stdctrls. Adds TCheckBox.Checked and TCheckBox.OnClick topics.
* TCheckBox.Checked replaces the linked topic in TButtonControl.
* TCheckBox.OnClick was omitted and links to the inherited topic (TControl).
2024-07-20 21:29:11 +01:00
..
freetype
ide
lazutils Docs: LazUtils/fileutil. Updates content in the ReadFileToString topic. 2024-07-18 00:52:45 +01:00
lcl Docs: LCL/stdctrls. Adds TCheckBox.Checked and TCheckBox.OnClick topics. 2024-07-20 21:29:11 +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