[Lazarus] Documentation rev33561

Hans-Peter Diettrich DrDiettrich1 at aol.com
Thu Nov 17 01:51:16 CET 2011

Felipe Monteiro de Carvalho schrieb:
> On Wed, Nov 16, 2011 at 4:01 PM, Felipe Monteiro de Carvalho
> <felipemonteiro.carvalho at gmail.com> wrote:
>> Please never document something as "[?] Does nothing."
> Just to add on that, I think it would read much better like this:
> This method is provided for descendent classes so that they may
> override it and do something when the active state of the form
> changes. In TCustomForm it does not do anything by design.

I'd prefer:

This method is called [when?]
It can be overridden [to do what?]

With the placeholders filled in with *reliable* and *useful* 
information. It should be obvious that virtual methods are designed for 
being overridden in derived classes. But he who overrides such a method 
*must* know about the purpose of the method, else nobody can ever 
override it in a meaningful way.


More information about the Lazarus mailing list