lazarus

mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-06-07 08:38:11 +02:00

History

kirkpatc 2395c1a8b7 FPDoc - added descriptions for TWinControl and TControl in Controls.xml; some definitions for scrollbars in TForms.xml; added links for TCustomListBox, TListBox, TCustomEdit, TMemoScrollBox, TCustomMemo, TEdit, TMemo, TCustomStaticText, TStaticText, TButtonControl, TCustomButton, TButton, TCustomCheckBox, TCheckBox, TToggleBox, TRadioButton, TCustomLabel and TLabel in StdCtrls.xml (finishing StdCtrls.xml) git-svn-id: trunk@16220 -		2008-08-25 11:08:39 +00:00
..
lcl	FPDoc - added descriptions for	2008-08-25 11:08:39 +00:00
find_cvs_fpdoc_files.pl	win64 fixes (from peter, modified)	2006-05-01 21:47:48 +00:00
multi_makeskel.pl	tool multi_makeskel.pl: fixed svn props and added option -r for recursive from Darius	2007-05-15 10:17:15 +00:00
README.txt	updated README	2006-03-10 21:26:18 +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.

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