lazarus/docs/xml
2010-12-20 13:16:57 +00:00
..
fcl fcl docs: update fpcanvas documentation from Darius (issue #18221) 2010-12-20 13:16:57 +00:00
lcl lcl docs: added skeletonxml documention for new xmlbase unit 2010-11-03 19:52:32 +00:00
rtl docs: added RTL and FCL entries. 2010-02-16 11:03:06 +00:00
find_cvs_fpdoc_files.pl
multi_makeskel.pl
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.

--------------------------------------------------------------------------------
They were created 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. But this will follow in a few weeks.

--------------------------------------------------------------------------------
Finding the new files, not yet in CVS (probably obsolete now):

perl find_cvs_fpdoc_files.pl -s ../../lcl -o lcl -l new

--------------------------------------------------------------------------------
Finding old the files in CVS not needed any more (probably obsolete now):

perl find_cvs_fpdoc_files.pl -s ../../lcl -o lcl -l old

--------------------------------------------------------------------------------
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

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

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

Finding the new files, not yet in CVS:
perl find_cvs_fpdoc_files.pl -s ../../lcl/interfaces/gtk \
  -o lcl/interfaces/gtk -l new

Finding old the files in CVS not needed any more:
perl find_cvs_fpdoc_files.pl -s ../../lcl/interfaces/gtk \
  -o lcl/interfaces/gtk -l old