kapidox: supporting also QML (and cmake, Python,, ...)

Ingo Klöcker kloecker at kde.org
Mon Aug 1 22:47:17 BST 2016

On Monday 01 August 2016 20:59:03 Olivier Churlaud wrote:
> > For a solution:
> > Perhaps at the generation side there could be another level right
> > below the library, for the interface (C++, QML, CMake, ...).
> > So "Product" > "Library" > "Interface",
> > 
> > By the example of Plasma Components
> > (https://api.kde.org/frameworks/plasma-framework) there would then
> > be in the header> 
> >      KDE API Reference > The KDE Frameworks > Plasma > QML
> >      KDE API Reference > The KDE Frameworks > Plasma > C++
> > 
> > and in the left sidebar there would be another section "Language"
> > (or better term) which would allow to switch to the docs for the
> > other interfaces supported (C++, QML, CMake, ...).
> To be honest, at the time of writing, I don't find it very good,
> because you don't look for CMake or QML libs. You look for a way to
> do something. In my opinion, the entry page should say "if you need
> to do this, use our CMake macro described here". "If you want to draw
> this type of interaction, our QML library described there is what you
> need' and so on.

Just a small comment: Based on my experience, I don't believe in entry 
pages. I believe in search engines. If I'm looking for a way to do 
something, then 95 % of the time I use a search engine (probably 
restricted to a certain website). Only 5 % of the time I go directly to 
the subpage which I think might describe what I'm looking for.


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

More information about the kde-core-devel mailing list