diff --git a/docs/xml/README.txt b/docs/xml/README.txt index a35b02d182..7460640f0a 100644 --- a/docs/xml/README.txt +++ b/docs/xml/README.txt @@ -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 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 \ -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. +files. -------------------------------------------------------------------------------- If you don't have perl installed, you can use the following command to update diff --git a/docs/xml/StyleGuide.txt b/docs/xml/StyleGuide.txt index c2a1b8916f..9d8aeef49e 100644 --- a/docs/xml/StyleGuide.txt +++ b/docs/xml/StyleGuide.txt @@ -23,7 +23,7 @@ Public items (methods...) are for use by coders, the short description can read "Use ... to ..." 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 -excess decoration, e.g.: +access decoration, e.g.: "Returns ..." instead of "ThisItem - reads the FItem field." @@ -59,7 +59,7 @@ For lenghty descriptions you can use paragraphs (

) like this: Then it's easy to copy a

line to all places, where paragraph breaks -should occur. +should occur. Keep in mind that these are XML files, not HTML. XML Syntax