lazarus/docs/xml
maxim e796cd5ba9 Merged revision(s) 59118 #2b512b893e, 59125 #70f0e3209a, 59169 #571647e302, 59175 #c9e4614e17, 59177 #75d1f28106 from trunk:
Docs: Fix short description for function StringToColor.
........
LazUtf8: leftpad escaped characters in Utf8EscapeControlChars if EscapeMode = emPascal. Prevents ambiguity when reading the result.
........
LazUtils: Move ExtractFileNameWithoutExt to LazFileUtils. Rhymes with ExtractFileNameOnly.
........
Delete old deprecated methods.
........
LazUtils: Move more functions from FileUtils to LazFileUtilities, deprecate the old ones.
........

git-svn-id: branches/fixes_2_0@59201 -
2018-09-30 22:45:40 +00:00
..
ide IDE: Retain anchored desktop configuration while AnchorDocking is not installed. Issue #32083, patch by joecare99. 2017-07-02 09:52:40 +00:00
lazutils docs: lazutils: fixed invalid fpdoc elements 2017-04-04 11:05:36 +00:00
lcl Merged revision(s) 59118 #2b512b893e, 59125 #70f0e3209a, 59169 #571647e302, 59175 #c9e4614e17, 59177 #75d1f28106 from trunk: 2018-09-30 22:45:40 +00:00
mkhtml.bat
multi_makeskel.pl
README.txt
StyleGuide.txt
updateXML.bat docs: build_lcl_docs: --footer 2017-06-02 20:43:00 +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.

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