Expose Plasma Workspace api to api.kde.org

Mainpage.dox

@@ -1,21 +0,0 @@
-/** @mainpage Plasma
-
-Documentation for the Plasma libraries and utilities.
-<p>
-- <a href="../engines/html/index.html"><b>engines</b></a>
-  (<a href="../engines/html/classes.html">classes</a>)\n
-  <i>Engines for Plasma</i>
-- <a href="../applets/html/index.html"><b>applets</b></a>
-  (<a href="../applets/html/classes.html">classes</a>)\n
-  <i>Plasma Applets</i>
-- <a href="../animators/html/index.html"><b>animators</b></a>
-  (<a href="../animators/html/classes.html">classes</a>)\n
-  <i>Plasma Animators</i>
-
-
-*/
-
-// DOXYGEN_SET_PROJECT_NAME = Plasma
-// DOXYGEN_SET_RECURSIVE = YES
-// DOXYGEN_EXCLUDE = engines applets animators
-// vim:ts=4:sw=4:expandtab:filetype=doxygen

README.md

@@ -0,0 +1,22 @@
+## Plasma Workspace
+
+Plasma Workspace is used as base for both Plama Desktop and Plasma Mobile.
+It contains shared KCMs, applets as well as multiple libraries.
+
+### TaskManager Library
+
+The Task Manager provides various QAbstractListModel-based model for listing
+Windows (TaskManager::AbstractWindowTasksModel), Startup tasks (TaskManager::StartupTasksModel) and Launcher
+Job (TaskManager::LauncherTasksModel).
+
+### Workspace Library
+
+libkworkspace provides functions to allow you to interact with the
+%KDE session manager (SessionManagement).
+
+### Notification Manager Library
+
+libnotificationmanager is responsible for listing notifications, closing them
+and interacting with them in Plasma. This class provides a %Qt model for jobs:
+NotificationManager::JobsModel. As well as a %Qt model for notifications and
+jobs: NotificationManager::Notifications.

libkworkspace/Mainpage.dox

@@ -1,21 +0,0 @@
-/** @mainpage Workspace library
-
-libkworkspace provides functions to allow you to interact with the
-%KDE session manager.
-
-@authors
-Matthias Kalle Dalheimer \<kalle@kde.org\><br>
-Oswald Buddenhagen \<ossi@kde.org\><br>
-Matthias Elter \<elter@kde.org\><br>
-Matthias Ettrich \<ettrich@kde.org\>
-
-@maintainers
-[Unknown/None]
-
-@licenses
-@lgpl
-
-*/
-
-// DOXYGEN_SET_PROJECT_NAME = libkworkspace
-// vim:ts=4:sw=4:expandtab:filetype=doxygen

libnotificationmanager/job.h

@@ -18,6 +18,14 @@ namespace NotificationManager
 {
 class JobPrivate;
 
+/**
+ * @short Represents a single job.
+ *
+ * A Job represents a special notification that has some progress information and in
+ * some cases can be suspended or killed.
+ *
+ * @author Kai Uwe Broulik <kde@privat.broulik.de>
+ */
 class NOTIFICATIONMANAGER_EXPORT Job : public QObject
 {
     Q_OBJECT

libnotificationmanager/jobsmodel.h

@@ -17,6 +17,9 @@ namespace NotificationManager
 {
 class JobsModelPrivate;
 
+/**
+ * A model used for listing Job.
+ */
 class NOTIFICATIONMANAGER_EXPORT JobsModel : public QAbstractListModel
 {
     Q_OBJECT

libnotificationmanager/notification.h

@@ -19,7 +19,7 @@
 namespace NotificationManager
 {
 /**
- * @short Represents a single notification
+ * @short Represents a single notification.
  *
  * @author Kai Uwe Broulik <kde@privat.broulik.de>
  **/

libtaskmanager/abstracttasksmodel.h

@@ -23,7 +23,6 @@ namespace TaskManager
  *
  * @author Eike Hein <hein@kde.org>
  **/
-
 class TASKMANAGER_EXPORT AbstractTasksModel : public QAbstractListModel, public AbstractTasksModelIface
 {
     Q_OBJECT

metainfo.yaml

@@ -0,0 +1,31 @@
+maintainer:
+- notmart
+description: Plasma Workspace
+platforms:
+    - name: Linux
+    - name: FreeBSD
+portingAid: false
+deprecated: false
+release: true
+
+group: Plasma
+public_lib: true
+public_source_dirs:
+    - libkworkspace
+    - libtaskmanager
+    - libnotificationmanager
+
+group_info:
+    name: plasma
+    fancyname: Plasma
+    maintainer: notmart
+    mailinglist: plasma-devel
+    platforms:
+      - Linux
+      - FreeBSD
+    description: Provides APIs to build plasma widgets, wallpaper plugins and more.
+    logo: konqi_frameworks.png
+    long_description:
+        - Plasma is a desktop environment for Linux and FreeBSD but it's built as a platforms
+          in which plugins can be built to extends its features or completely new desktop
+          environment can be built on top.