updated API documentation

git-svn-id: http://svn.code.sf.net/p/qmmp-dev/code/trunk/qmmp@9870 90c681e8-e032-0410-971d-27865f9a5e38

1 files changed, 12 insertions, 5 deletions

diff --git a/src/qmmpui/generalfactory.h b/src/qmmpui/generalfactory.h
index 9e31c6a38..909496023 100644
--- a/src/qmmpui/generalfactory.h
+++ b/src/qmmpui/generalfactory.h
@@ -29,13 +29,15 @@ class QWidget;
 class Control;
 class General;
 
+/*! @brief Structure to store widget description provided by general plugin.
+ */
 struct WidgetDescription
 {
-    int id;
-    QString name;
-    QString shortcut;
-    Qt::DockWidgetArea area;
-    Qt::DockWidgetAreas allowedAreas;
+    int id;                           /*!< Widget ID */
+    QString name;                     /*!< Widget name (translatable) */
+    QString shortcut;                 /*!< Default key shortcut */
+    Qt::DockWidgetArea area;          /*!< Default area */
+    Qt::DockWidgetAreas allowedAreas; /*!< Allowed areas */
 };
 
 
@@ -70,6 +72,11 @@ public:
      * Creates object of the General class.
      */
     virtual QObject *create(QObject *parent) = 0;
+    /*!
+     * Creates widget provided by plugin. Default emplementation returns \b nullptr.
+     * \param id Widget ID.
+     * \param parent Parent Widget.
+     */
     virtual QWidget *createWidget(int id, QWidget *parent);
     /*!
      * Creates configuration dialog.