lazarus

mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-11-28 07:37:27 +01:00

History

dsiders 127ba96ec8 Docs: LCL/controls. Updates content in child sizng-related topics, including: * TChildControlResizeStyle * TControlChildrenLayout * TControlChildSizing * TControlChildSizing.ControlsPerLine * TControlChildSizing.EnlargeHorizontal * TControlChildSizing.EnlargeVertical * TControlChildSizing.Layout * TControlChildSizing.ShrinkHorizontal * TControlChildSizing.ShrinkVertical * TControlChildSizing.TopBottomSpacing * The changes try to simplify and consolidate the content in these topics. * The updates focus less on the innards of the layout algorithms and more * on their observable behavior. * The comments in controls.pp source code need to be updated. * They do not reflect the actual implementation any longer.		2024-10-20 01:58:23 +01:00
..
freetype	Docs: FreeType. Updates external references (uses) for changes in `733ac0ed`.	2024-10-20 01:58:20 +01:00
ide
lazutils	Docs: LazUtils/fileutil. Adds missing TFileSearcher.OnQueryDirectoryEnter topic.	2024-10-20 01:58:18 +01:00
lcl	Docs: LCL/controls. Updates content in child sizng-related topics, including:	2024-10-20 01:58:23 +01:00
mkhtml.bat
multi_makeskel.pl
README.txt
StyleGuide.txt
updateXML.bat

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