qml controls and documentation

Marco Martin notmart at gmail.com
Mon Jul 28 16:11:10 UTC 2014


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?

-- 
Marco Martin


More information about the Plasma-devel mailing list