qml controls and documentation

[Aleix Pol]

On Mon, Jul 28, 2014 at 6:11 PM, Marco Martin <notmart at gmail.com> wrote:

> Hi all,
>
> right now the plasma qml components are documented not bad, like:
>
> http://api.kde.org/frameworks-api/frameworks5-apidocs/plasma-framework/html/classorg_1_1kde_1_1plasma_1_1components_1_1TextField.html
>
> however, porting them to QtControls, has the sideeffect of pretty much
> killing
> the documentation of those that will inherit from a qtcontrol.
>
> like, button became:
>
> http://api.kde.org/frameworks-api/frameworks5-apidocs/plasma-framework/html/classorg_1_1kde_1_1plasma_1_1components_1_1Button.html
>
> even tough one can just say just use the documentation of controls, since
> there isn't an exact 100% correspondence, i would like to still have that
> doc
> usable.
>
> does somebody knows if is possible with the markup used now for extracting
> documentation to still have comments to document all the properties, even
> those *not* defined in the qml file in question?
>

It should probably look more or less like KPushButton [1], properly showing
inheritance. Anybody knows how this is implemented in doxygen?

Aleix

[1]
http://api.kde.org/4.12-api/kdelibs-apidocs/kdeui/html/classKPushButton.html
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/plasma-devel/attachments/20140728/105f400c/attachment.html>