lazarus/docs/xml
vincents 687b5e0be2 fixed link to example file
git-svn-id: trunk@8988 -
2006-03-22 19:04:16 +00:00
..
lcl fixed link to example file 2006-03-22 19:04:16 +00:00
find_cvs_fpdoc_files.pl updated lcl fpdoc 2004-08-24 19:33:00 +00:00
multi_makeskel.pl updated lcl fpdoc 2004-08-24 19:33:00 +00:00
README.txt updated README 2006-03-10 21:26:18 +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.

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