Provide documentation on FrameSvgItem and ColorScope

without an @class no documentation is generated at all
This commit is contained in:
David Edmundson 2014-08-12 21:03:30 +02:00
parent 0ada27caa7
commit 6bdf7487cd
3 changed files with 22 additions and 1 deletions

View File

@ -2,6 +2,7 @@
<h2>import org.kde.plasma.core</h2>
- Main
- Plasma::DataModel
- Plasma::DataSource
- Plasma::FrameSvgItem
@ -12,6 +13,7 @@
- ToolTipProxy
- RunnerModel
- IconItem
- ColorScope
Elements from kdelibs which are exposed by PlasmaCore:

View File

@ -28,7 +28,13 @@
class QQuickItem;
/**
* @class ColorScope
*
* @short Sets the colour scheme to be used by all child items
*
* It is exposed as org.kde.plasma.core.ColorScope
*/
class ColorScope : public QQuickItem
{
Q_OBJECT

View File

@ -33,6 +33,11 @@ namespace Plasma
class FrameSvg;
class SVGTextureNode;
/**
* @class FrameSvgItemMargins
*
* @short The size of margins for a frame.
*/
class FrameSvgItemMargins : public QObject
{
Q_OBJECT
@ -79,6 +84,14 @@ private:
bool m_fixed;
};
/**
* @class FrameSvgItem
*
* @short Provides an SVG with borders.
*
* It is exposed as org.kde.plasma.core.FrameSvgItem
*/
class FrameSvgItem : public QQuickItem
{
Q_OBJECT