lazarus/docs/xml
maxim 61aa952c85 Merged revision(s) 65243 #70e776f427, 65249 #a3ec8bf364, 65254-65256 #9556e1f744-#9556e1f744, 65261-65271 #9883a587f5-#9883a587f5, 65274 #03f68b4474, 65278-65279 #79264e3cc9-#79264e3cc9 from trunk:
Docs: LazUtils, Added topics for TWaitableSection.
........
Docs: LazUtils. Updated topic content in laz2_dom.xml.
........
Docs: LazUtils. Fixed content model error.
........
Docs: LazUtils. Updates for missing module descriptions.
........
Docs: LCL,LazUtils. Updates for module descriptions.
........
Docs: LCL,LazUtils. Updated topics for source changes in version 2.1.
........
Docs: LCL. Fixes missing punctuation in short descriptions (partial).
........
Docs: LCL. Fixes missing punctuation in short descriptions (partial).
........
Docs: LCL. Fixes missing punctuation in short descriptions (partial).
........
Docs: LCL. Fixes XML error in previous patch.
........
Docs: LCL. Fixes missing punctuation in short descriptions (partial).
........
Docs: LCL. Fixes missing punctuation in short descriptions (partial).
........
Docs: LCL. Fixes missing punctuation in short descriptions (FINAL).
........
Docs: LazUtils. Fixes missing punctuation in short descriptions (Partial).
........
Docs: LazUtils. Fixes missing punctuation in short descriptions (FINAL).
........
Docs: FreeType. Fixes missing punctuation in short descriptions.
........
Docs: LCL. Fixes missing punctuation in short descriptions after var tag.
........
Docs (LazControls, RTTIControls): added missing punctuation in short descriptions, patch by Don, bug #39018
........
Docs: LCL. Minor updates to TPen, LCL version constants.
........

git-svn-id: branches/fixes_2_2@65284 -
2021-06-22 00:43:37 +00:00
..
freetype Merged revision(s) 65243 #70e776f427, 65249 #a3ec8bf364, 65254-65256 #9556e1f744-#9556e1f744, 65261-65271 #9883a587f5-#9883a587f5, 65274 #03f68b4474, 65278-65279 #79264e3cc9-#79264e3cc9 from trunk: 2021-06-22 00:43:37 +00:00
ide
lazutils Merged revision(s) 65243 #70e776f427, 65249 #a3ec8bf364, 65254-65256 #9556e1f744-#9556e1f744, 65261-65271 #9883a587f5-#9883a587f5, 65274 #03f68b4474, 65278-65279 #79264e3cc9-#79264e3cc9 from trunk: 2021-06-22 00:43:37 +00:00
lcl Merged revision(s) 65243 #70e776f427, 65249 #a3ec8bf364, 65254-65256 #9556e1f744-#9556e1f744, 65261-65271 #9883a587f5-#9883a587f5, 65274 #03f68b4474, 65278-65279 #79264e3cc9-#79264e3cc9 from trunk: 2021-06-22 00:43:37 +00:00
mkhtml.bat
multi_makeskel.pl
README.txt
StyleGuide.txt
updateXML.bat

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