Proposal: new non-shipping module for examples

[Brad Hards]

On Friday 03 October 2008 12:46:16 pm Aaron J. Seigo wrote:
> On Thursday 02 October 2008, Brad Hards wrote:
> > 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.
OK, the users of the API?

> > 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?
If you have an external module and want to use all the examples (as opposed 
to "having" them), you'll probably need the source (or the -devel packages) 
of every module anyway. I don't think that this is all that common anyway - 
seems unlikely that most people aren't interested in "everything" - they have 
some focus (perhaps plasma or akonadi, libraries or accessibility, whatever) 
and would like the examples for that.

In any case, you can't do much development without the API documentation, and 
to have all the API documentation for KDE, you have to download docs for each 
package. You could browse the API docs online of course, and that could 
include the examples if the doxygen magic was set up to do so.

> 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 don't understand why they aren't in a "useful state for browsing" though.

I do agree that they don't provide a good template, and this is a disadvantage 
that I hadn't considered. I'm not sure that there is a way to fix this in 
doxygen (other than needing to manually insert a hyperlink to the file).

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

Also note my earlier concern that you won't be able to compile and play with 
everything in the examples module without all the sources (or -devel 
packages).

Brad