From 9f21a5f3c222f392dc5370abda0417d80216ea37 Mon Sep 17 00:00:00 2001
From: trialuser02 <trialuser02@90c681e8-e032-0410-971d-27865f9a5e38>
Date: Thu, 29 Apr 2021 21:47:16 +0000
Subject: updated API documentation

git-svn-id: http://svn.code.sf.net/p/qmmp-dev/code/trunk/qmmp@9870 90c681e8-e032-0410-971d-27865f9a5e38
---
 src/qmmpui/general.h | 13 +++++++++++++
 1 file changed, 13 insertions(+)

(limited to 'src/qmmpui/general.h')

diff --git a/src/qmmpui/general.h b/src/qmmpui/general.h
index 0e9a4830f..554873188 100644
--- a/src/qmmpui/general.h
+++ b/src/qmmpui/general.h
@@ -47,8 +47,21 @@ public:
      * Returns a list of the enabled general plugin factories.
      */
     static QList<GeneralFactory *> enabledFactories();
+    /*!
+     * Returns a list of the enabled widget IDs.
+     */
     static QStringList enabledWidgets();
+    /*!
+     * Returns widget description.
+     * @param id Widget ID.
+     */
     static WidgetDescription widgetDescription(const QString &id);
+    /*!
+     * Creates widget provided by general plugin. May return \b nullptr
+     * if widget ID is not found.
+     * \param id Widget ID.
+     * \param parent Parent Widget.
+     */
     static QWidget *createWidget(const QString &id, QWidget *parent);
     /*!
      * Returns plugin file path.
-- 
cgit v1.2.3-13-gbd6f