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

List:       kde-core-devel
Subject:    Re: kdelibs API documentation (was Re: Moving ThreadWeaver to kdelibs)
From:       Kevin Krammer <kevin.krammer () gmx ! at>
Date:       2005-09-15 18:36:19
Message-ID: 200509152036.19431.kevin.krammer () gmx ! at
[Download RAW message or body]


On Thursday 15 September 2005 20:01, Adriaan de Groot wrote:

> You can also use grouping, for instance you can do
>
> /** @defgroup implementors Notes for Implementations */
>
> /** Do something cool. */
>
> void coolness();
>
> /** @addtogroup implementors
>
> These are the notes about a method relevant for implementors; they should
> come after the method definition and @em before the dox for the next
> method. To implement coolness, you need a baseball cap.
> */

Interesting, will have to try this.

> I'm not entirely sure how these come out; alternatively, subpaging may be
> an option -- I can figure that out for you if you like and write up a
> suggested dox style for interfaces.

That would be great!

Given that we already have quite some interfaces and will likely have even 
more in KDE4, it would be good IMHO to make this case part of the 
recommendations or style guidelines.

Cheers,
Kevin

-- 
Kevin Krammer <kevin.krammer@gmx.at>
Qt/KDE Developer, Debian User
Moderator: www.mrunix.de (German), www.qtforum.org

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

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