lazarus/docs/xml
mattias 6ce7e710da docs: lcl: fixed some fpdoc errors
git-svn-id: branches/fixes_1_6@54519 -
2017-04-04 12:34:35 +00:00
..
ide IDE docs: fixed encoding 2012-07-02 15:52:36 +00:00
lazutils LazUtils: Use LookupStringList in LazUtils package. Remove old DictionaryStringList files. 2015-07-07 12:10:35 +00:00
lcl docs: lcl: fixed some fpdoc errors 2017-04-04 12:34:35 +00:00
mkhtml.bat Docs: add some scripts and StyleGuide 2011-09-20 04:25:48 +00:00
multi_makeskel.pl
README.txt docs: updated 2012-07-02 15:53:04 +00:00
StyleGuide.txt docs: updated 2012-07-02 15:53:04 +00:00
updateXML.bat Docs: add some scripts and StyleGuide 2011-09-20 04:25:48 +00:00

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