Proposal: new non-shipping module for examples

[Aaron J. Seigo]

On Thursday 02 October 2008, Brad Hards wrote:
> On Thursday 02 October 2008 01:26:44 am Aaron J. Seigo wrote:
> > one of the trends i've noticed since starting kde4 is that there is an
> > increase in high level documentation[1] and that often includes example
> > implementations. these are usually toy apps or artificially simplified
> > plugins demonstrating techniques and API usage.
>
> OK, so who are these intended for? In my mind, it is the users of the
> extension APIs who benefit most

it is the users of any API extension or otherwise.
 
> I think the best approach is to ship it inside the module,

so to get all kde examples you have to download the source of every module 
with examples?

> QCA does this. The version of the API docs on http://api.kde.org ignores
> the Doxyfile that ships with QCA (why?), but you can see how it could work
> at http://www.frogmouth.net/qca/apidocs/html/index.html (which is a bit out
> of date as a reference source), or just build the API documentation
> yourself.

the links to the source code there are not in a particularly useful state for 
browsing and using as a template starting point either, they are html'd.

i'd *like* to give people a whole set of examples covering everything possible 
in KDE that they can compile and play with.

-- 
Aaron J. Seigo
humru othro a kohnu se
GPG Fingerprint: 8B8B 2209 0C6F 7C47 B1EA  EE75 D6B7 2EB1 A7F1 DB43

KDE core developer sponsored by Trolltech

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 197 bytes
Desc: This is a digitally signed message part.
URL: <http://mail.kde.org/pipermail/kde-core-devel/attachments/20081002/bc5dca19/attachment.sig>