From 9fb0f888680066dd48904d30a9a8e5f18137b180 Mon Sep 17 00:00:00 2001 From: Carl Schwan Date: Wed, 25 Aug 2021 11:38:32 +0000 Subject: [PATCH] Expose Plasma Workspace api to api.kde.org --- Mainpage.dox | 21 ------------------ README.md | 22 +++++++++++++++++++ libkworkspace/Mainpage.dox | 21 ------------------ libnotificationmanager/job.h | 8 +++++++ libnotificationmanager/jobsmodel.h | 3 +++ libnotificationmanager/notification.h | 2 +- libtaskmanager/abstracttasksmodel.h | 1 - metainfo.yaml | 31 +++++++++++++++++++++++++++ 8 files changed, 65 insertions(+), 44 deletions(-) delete mode 100644 Mainpage.dox create mode 100644 README.md delete mode 100644 libkworkspace/Mainpage.dox create mode 100644 metainfo.yaml diff --git a/Mainpage.dox b/Mainpage.dox deleted file mode 100644 index acf9e85cb..000000000 --- a/Mainpage.dox +++ /dev/null @@ -1,21 +0,0 @@ -/** @mainpage Plasma - -Documentation for the Plasma libraries and utilities. -

-- engines - (classes)\n - Engines for Plasma -- applets - (classes)\n - Plasma Applets -- animators - (classes)\n - Plasma Animators - - -*/ - -// DOXYGEN_SET_PROJECT_NAME = Plasma -// DOXYGEN_SET_RECURSIVE = YES -// DOXYGEN_EXCLUDE = engines applets animators -// vim:ts=4:sw=4:expandtab:filetype=doxygen diff --git a/README.md b/README.md new file mode 100644 index 000000000..fb242dacd --- /dev/null +++ b/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. diff --git a/libkworkspace/Mainpage.dox b/libkworkspace/Mainpage.dox deleted file mode 100644 index e8744f239..000000000 --- a/libkworkspace/Mainpage.dox +++ /dev/null @@ -1,21 +0,0 @@ -/** @mainpage Workspace library - -libkworkspace provides functions to allow you to interact with the -%KDE session manager. - -@authors -Matthias Kalle Dalheimer \
-Oswald Buddenhagen \
-Matthias Elter \
-Matthias Ettrich \ - -@maintainers -[Unknown/None] - -@licenses -@lgpl - -*/ - -// DOXYGEN_SET_PROJECT_NAME = libkworkspace -// vim:ts=4:sw=4:expandtab:filetype=doxygen diff --git a/libnotificationmanager/job.h b/libnotificationmanager/job.h index c3c8039cd..8e44c5e84 100644 --- a/libnotificationmanager/job.h +++ b/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 + */ class NOTIFICATIONMANAGER_EXPORT Job : public QObject { Q_OBJECT diff --git a/libnotificationmanager/jobsmodel.h b/libnotificationmanager/jobsmodel.h index c33b2d9f6..874f0283b 100644 --- a/libnotificationmanager/jobsmodel.h +++ b/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 diff --git a/libnotificationmanager/notification.h b/libnotificationmanager/notification.h index 464b68282..9f04a4e20 100644 --- a/libnotificationmanager/notification.h +++ b/libnotificationmanager/notification.h @@ -19,7 +19,7 @@ namespace NotificationManager { /** - * @short Represents a single notification + * @short Represents a single notification. * * @author Kai Uwe Broulik **/ diff --git a/libtaskmanager/abstracttasksmodel.h b/libtaskmanager/abstracttasksmodel.h index 6879432ce..63e74ab5a 100644 --- a/libtaskmanager/abstracttasksmodel.h +++ b/libtaskmanager/abstracttasksmodel.h @@ -23,7 +23,6 @@ namespace TaskManager * * @author Eike Hein **/ - class TASKMANAGER_EXPORT AbstractTasksModel : public QAbstractListModel, public AbstractTasksModelIface { Q_OBJECT diff --git a/metainfo.yaml b/metainfo.yaml new file mode 100644 index 000000000..dcf5bf032 --- /dev/null +++ b/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.