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

List:       kde-core-devel
Subject:    Re: documentation techniques (kind request)
From:       David Faure <david () mandrakesoft ! com>
Date:       2000-03-24 1:07:44
[Download RAW message or body]

Hehe, you think that with a subject in French it will make more
people look at the mail ? ;-))

On Thu, Mar 23, 2000 at 08:02:49PM -0500, Cristian Tibirna wrote:
> 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.

True.

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

-- 
David FAURE, david@mandrakesoft.com, faure@kde.org
http://home.clara.net/faure/
KDE, Making The Future of Computing Available Today
See http://www.kde.org/kde1-and-kde2.txt for how to set up KDE 2

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