[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:       Adriaan de Groot <groot () kde ! org>
Date:       2005-09-14 15:38:20
Message-ID: 200509141738.20939.groot () kde ! org
[Download RAW message or body]

On Wednesday 14 September 2005 14:27, Brad Hards wrote:
> See
> http://websvn.kde.org/trunk/kdesupport/qca/examples/examples.doco?rev=41935
>8&view=markup for how simple it can get.

Bloody brilliant, Brad. Something to push all over the place (see also the 
KResources apidox thread on -devel, which found the same kind of out-of-sync 
examples). Only problem I can see with this is that the code examples have to 
be compilable, so you can't do the kind of fake example like

#include <foo>

Foo a();
a.doThis();

which you might otherwise. I think it's an acceptable tradeoff to say that 
examples must be really accurate.

-- 
These are your friends - Adem
    GPG: FEA2 A3FE Adriaan de Groot
[prev in list] [next in list] [prev in thread] [next in thread]