[Lazarus] Extending FCL documentation

Felipe Monteiro de Carvalho felipemonteiro.carvalho at gmail.com
Wed Feb 8 13:22:35 CET 2012


On Wed, Feb 8, 2012 at 12:25 PM, Graeme Geldenhuys
<graemeg.lists at gmail.com> wrote:
> And here we come full circle!  In which format should we document
> these features?  XML, IPF, TXT, RTF, ODT, AsciiDoc, DocBook, Wiki
> etc....?  And are these features related to the LCL framework, Lazarus
> IDE itself, or many of the utility apps included in the Lazarus
> repository - thus it might dictate which help format must be used....
> class documentation or general application or README help.

LCL and LazUtils features need to be documented in 2 places:

1-> In the Wiki
2-> In the XML files in lazarus/docs/xml/lcl/

Example:

Wiki-> http://wiki.lazarus.freepascal.org/LCL_Accessibility
XML-> http://svn.freepascal.org/cgi-bin/viewvc.cgi/trunk/docs/xml/lcl/controls.xml?view=markup&root=lazarus

And with links between them.

The help format for outputing the XML is irrelevant in this work. I
generally test with html.

-- 
Felipe Monteiro de Carvalho




More information about the Lazarus mailing list