Add more missing @class and @short descriptors

This commit is contained in:
David Edmundson 2014-08-12 23:12:15 +02:00
parent ace0209e0e
commit 5478c7e3c2
8 changed files with 35 additions and 8 deletions

View File

@ -2,18 +2,18 @@
<h2>import org.kde.plasma.core</h2> <h2>import org.kde.plasma.core</h2>
- Main - ColorScope
- Plasma::DataModel - Plasma::DataModel
- Plasma::DataSource - Plasma::DataSource
- IconItem
- Plasma::FrameSvgItem - Plasma::FrameSvgItem
- Plasma::SvgItem - Plasma::SvgItem
- Plasma::SortFilterModel - Plasma::Theme
- DialogProxy - PlasmaQuick::Dialog
- SortFilterModel
- ThemeProxy - ThemeProxy
- ToolTipProxy - ToolTip
- RunnerModel - Units
- IconItem
- ColorScope
*/ */

View File

@ -34,6 +34,10 @@ namespace Plasma
class DataSource; class DataSource;
class DataModel; class DataModel;
/**
* @class SortFilterModel
* @short Filter and sort an existing QAbstractItemModel
*/
class SortFilterModel : public QSortFilterProxyModel class SortFilterModel : public QSortFilterProxyModel
{ {
Q_OBJECT Q_OBJECT
@ -121,6 +125,10 @@ private:
QHash<QString, int> m_roleIds; QHash<QString, int> m_roleIds;
}; };
/**
* @class DataModel
* @short DataSource data as a model
*/
class DataModel : public QAbstractItemModel class DataModel : public QAbstractItemModel
{ {
Q_OBJECT Q_OBJECT

View File

@ -36,6 +36,10 @@ namespace Plasma
{ {
class DataEngine; class DataEngine;
/**
* @class DataSource
* @short Provides data from a range of plugins
*/
class DataSource : public QObject, DataEngineConsumer class DataSource : public QObject, DataEngineConsumer
{ {
Q_OBJECT Q_OBJECT

View File

@ -31,6 +31,10 @@
class QPropertyAnimation; class QPropertyAnimation;
/**
* @class IconItem
* @short Displays an icon, either from the standard QIcon system or where applicable from the theme SVG files
*/
class IconItem : public QQuickItem class IconItem : public QQuickItem
{ {
Q_OBJECT Q_OBJECT

View File

@ -29,6 +29,9 @@ namespace Plasma
class Svg; class Svg;
/**
* @class SvgItem
*/
class SvgItem : public QQuickItem class SvgItem : public QQuickItem
{ {
Q_OBJECT Q_OBJECT

View File

@ -32,6 +32,8 @@ class QGraphicsWidget;
class ToolTipDialog; class ToolTipDialog;
/** /**
* @class ToolTip
*
* An Item managing a Plasma-themed tooltip. It is rendered in its own window. * An Item managing a Plasma-themed tooltip. It is rendered in its own window.
* You can either specify iconSource, mainText and subText, or a custom Component * You can either specify iconSource, mainText and subText, or a custom Component
* that will be put inside the tooltip. By specifying the target property, you * that will be put inside the tooltip. By specifying the target property, you

View File

@ -28,6 +28,11 @@
class QQuickItem; class QQuickItem;
/**
* @class Units
* @short Expose sizes to QML
*/
class Units : public QObject class Units : public QObject
{ {
Q_OBJECT Q_OBJECT

View File

@ -53,7 +53,8 @@ namespace PlasmaQuick
class DialogPrivate; class DialogPrivate;
/** /**
* QML wrapper for dialogs * @class Dialog
* @short QML wrapper for dialogs
* *
* Exposed as `PlasmaCore.Dialog` in QML. * Exposed as `PlasmaCore.Dialog` in QML.
*/ */