[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:       Dominik Haumann <dhdev () gmx ! de>
Date:       2005-09-15 18:42:25
Message-ID: 200509152042.25213.dhdev () gmx ! de
[Download RAW message or body]

On Thursday 15 September 2005 20:36, Kevin Krammer wrote:
> 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.
I agree to all this, *provided* that it does not add complexity.

If another developer wants to change things he has to be familiar with this 
concepts, and I guess almost noone is (at least I'm not ;)). If it is 
really simple to understand maybe we should try it.

-- 
Dominik
[prev in list] [next in list] [prev in thread] [next in thread]