[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-core-devel
Subject:    documentation techniques (kind request)
From:       Cristian Tibirna <ctibirna () total ! net>
Date:       2000-03-24 1:02:49
[Download RAW message or body]

Hi

I believe it would be *very* useful if a class which has (many) overloaded
constructors would have a bit more descriptive documentation. Especially
marking *what* the differences are in using one or other constructor. 

If for methods this kind of things is rather obvious only from the
differences in parameter sets, for constructors it's rather difficult.

E.g. kdeui/knuminput.h: KIntNumInput class has 2 constructors that have as
documentation, both, the word "Constructor" :-(

Thanks


Cristian Tibirna 

[prev in list] [next in list] [prev in thread] [next in thread]