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

List:       kde-commits
Subject:    Re: kdelibs/kate
From:       Christoph Cullmann <cullmann () babylon2k ! de>
Date:       2005-03-13 11:37:14
Message-ID: 200503131237.17609 () cullmann
[Download RAW message or body]


On Sunday 13 March 2005 13:00, Anders Lund wrote:
> On Sunday 13 March 2005 12:00, Christoph Cullmann wrote:
> > CVS commit by cullmann:
> >
> > don't make old faults, document the new header verbose
>
> If your goal is to document the header, 'Cool, this is all we need here' is
> a poor attempt, as well as 'Some common stuff' frankly. Put something that
> explains the purpose of the documented object. A namespace is an object to
> doxygen, while it makes absolute 0 sense to use doxygen syntax on a line
> above a list of declared classes. If you want to add doxygen comments for
> everything but namespaces, classes or class methods, reading the doxygen
> manual would be good ;)
? I don't think the additional comments will hurt doxygen, or? that they won't 
come up anywhere is clear, only for readability to the sources.

-- 
Christoph Cullmann
KDE Developer, kde.org Maintainance Team
http://www.babylon2k.de, cullmann@kde.org

[Attachment #3 (application/pgp-signature)]

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