[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-commits
Subject:    [plasma-mediacenter/ochurlaud/split_public_lib] libs/src: Api documentation of AbstractDataSource
From:       Olivier CHURLAUD <olivier () churlaud ! com>
Date:       2016-11-19 15:41:52
Message-ID: E1c87m4-0004Dx-Jj () code ! kde ! org
[Download RAW message or body]

Git commit bbd1e5fff9c7a145c83616b91e173acd084e6ee5 by Olivier CHURLAUD.
Committed on 19/11/2016 at 15:41.
Pushed by ochurlaud into branch 'ochurlaud/split_public_lib'.

Api documentation of AbstractDataSource

M  +32   -0    libs/src/abstractdatasource.h

http://commits.kde.org/plasma-mediacenter/bbd1e5fff9c7a145c83616b91e173acd084e6ee5

diff --git a/libs/src/abstractdatasource.h b/libs/src/abstractdatasource.h
index 3a9faff..5a3196e 100644
--- a/libs/src/abstractdatasource.h
+++ b/libs/src/abstractdatasource.h
@@ -28,13 +28,45 @@
 class MediaLibrary;
 
 namespace KMediaCollection {
+
+/**
+ * @brief Abstract class for DataSources
+ *
+ * Example of use:
+ * ```
+ * KPluginLoader loader(QStringLiteral("plasma/mediacollection/datasources/MySource"));
 + * KPluginFactory* factory = loader.factory();
+ * const QVariantList args = QVariantList() << loader.metaData().toVariantMap();
+ * if(factory)
+ * {
+ *     KMediaCollection::AbstractDataSource *dataSource = \
factory->create<KMediaCollection::AbstractDataSource>(0, args); + *     if \
(dataSource) { + *         \
dataSource->setMediaLibrary(SingletonFactory::instanceFor<MediaLibrary>()); + *       \
dataSource->start(); + *         connect(QApplication::instance(), \
SIGNAL(destroyed(QObject*)), dataSource, SLOT(quit())); + *         qDebug() << \
"Success"; + *     } else {
+ *         qDebug() << "Failure";
+ *     }
+ * }
+ * ```
+ */
 class KMEDIACOLLECTION_EXPORT AbstractDataSource : public QThread
 {
     Q_OBJECT
 public:
+    /**
+     * @brief Constructor
+     * @param parent
+     * @param QVariantList arguments
+     */
     explicit AbstractDataSource(QObject* parent = 0, const QVariantList& = \
QVariantList());  ~AbstractDataSource();
 
+    /**
+     * @brief Set the MediaLibrary
+     * @param mediaLibrary
+     */
     void setMediaLibrary(MediaLibrary *mediaLibrary);
 
 protected:


[prev in list] [next in list] [prev in thread] [next in thread]