From kde-core-devel  Fri Mar 24 01:02:49 2000
From: Cristian Tibirna <ctibirna () total ! net>
Date: Fri, 24 Mar 2000 01:02:49 +0000
To: kde-core-devel
Subject: documentation techniques (kind request)
X-MARC-Message: https://marc.info/?l=kde-core-devel&m=95385964531920

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