[Lazarus] Documentation rev33561
graemeg.lists at gmail.com
Thu Nov 17 08:05:36 CET 2011
On 17/11/2011, Felipe Monteiro de Carvalho <felipemonteiro.carvalho at g...> wrote:
> If you don't know what a method does, don't change it's description,
> but don't put [?] in the documentation and also don't write that you
> don't know what something does.
I have to agree with Felipe here. Seeing [?] inside the documentation
itself does give the documentation a "bad smell". Why not simply use
the comment tags [eg: <!-- my comment here -->] inside the XML files.
That way it doesn't appear inside the documentation context, but the
XML is searchable to find areas that need to be addressed by somebody
- Graeme -
fpGUI - a cross-platform Free Pascal GUI toolkit
More information about the Lazarus