paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-10-26 16:22:04 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: updated

Browse Source 
git-svn-id: trunk@37851 -
This commit is contained in:
mattias 2012-07-02 15:53:04 +00:00
parent 8528c56932
commit 658c75476f
2 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/xml/README.txt
View File

@ -3,13 +3,15 @@ These are the fpdoc xml files of the lazarus units.
The lcl directory contains the fpdoc xml files for the lcl. For example The lcl directory contains the fpdoc xml files for the lcl. For example
lcl/controls.xml for controls.pp. lcl/controls.xml for controls.pp.
You can create new entries with the fpdoc editor of the IDE (View / FPDoc Editor).
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------
They were created with: 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 \ perl multi_makeskel.pl -p lcl -s ../../lcl -o lcl \
-i '-Fi/path/to/lazarus/lcl/include' -x -i '-Fi/path/to/lazarus/lcl/include' -x
At the moment the fpdoc tool 'makeskel' is not yet capable of updating the At the moment the fpdoc tool 'makeskel' is not yet capable of updating the
files. But this will follow in a few weeks. files.
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------
If you don't have perl installed, you can use the following command to update If you don't have perl installed, you can use the following command to update

4
docs/xml/StyleGuide.txt
View File

@ -23,7 +23,7 @@ Public items (methods...) are for use by coders, the short description can read
"Use ... to ..." "Use ... to ..."
Other items can be hit during coding or debugging, the short description should Other items can be hit during coding or debugging, the short description should
provide meaningful information in the FPDoc editor or in the popup hints. Avoid provide meaningful information in the FPDoc editor or in the popup hints. Avoid
excess decoration, e.g.: access decoration, e.g.:
"Returns ..." "Returns ..."
instead of instead of
"<var>ThisItem<var> - reads the <link id="Class.FItem">FItem</link> field." "<var>ThisItem<var> - reads the <link id="Class.FItem">FItem</link> field."
@ -59,7 +59,7 @@ For lenghty descriptions you can use paragraphs (<p>) like this:
</descr> </descr>
Then it's easy to copy a </p><p> line to all places, where paragraph breaks Then it's easy to copy a </p><p> line to all places, where paragraph breaks
should occur. should occur. Keep in mind that these are XML files, not HTML.
XML Syntax XML Syntax