Graeme Geldenhuys schrieb:
On 17/11/2011, Felipe Monteiro de Carvalho <felipemonteiro.carvalho@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


--
_______________________________________________
Lazarus mailing list
[email protected]
http://lists.lazarus.freepascal.org/mailman/listinfo/lazarus

Reply via email to