[Lazarus] Documentation rev33561

Hans-Peter Diettrich DrDiettrich1 at aol.com
Thu Nov 17 14:19:47 CET 2011


Graeme Geldenhuys schrieb:
> 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".

Documentation is not winning an price for beauty, but for correctness 
and usability. If you don't like the [?] marks, then start replacing 
them by the missing information.

DoDi





More information about the Lazarus mailing list