lazarus

mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-04-06 18:38:15 +02:00

History

mattias d1fa8908c2 lcl: fix docs about TControl.SetBounds git-svn-id: branches/fixes_1_8@55843 -		2017-09-12 07:17:20 +00:00
..
ide	IDE docs: fixed encoding	2012-07-02 15:52:36 +00:00
lazutils	docs: lazutils: fixed invalid fpdoc elements	2017-04-04 11:05:36 +00:00
lcl	lcl: fix docs about TControl.SetBounds	2017-09-12 07:17:20 +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: build_lcl_docs: --footer	2017-06-02 20:43:25 +00:00

README.txt

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