From 86e89dd309977bbb80e616ad8666ad9e3693df12 Mon Sep 17 00:00:00 2001 From: David Edmundson Date: Sun, 21 Dec 2014 21:02:39 +0100 Subject: [PATCH] Document WallpaperInterface Change-Id: I25819a1d11fb63d3685a6fa0940e0c2f88e5cfd4 --- src/plasmaquick/Mainpage.dox | 7 ++++++- src/scriptengines/qml/plasmoid/wallpaperinterface.h | 7 +++++++ 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/src/plasmaquick/Mainpage.dox b/src/plasmaquick/Mainpage.dox index 970295834..3f92a14aa 100644 --- a/src/plasmaquick/Mainpage.dox +++ b/src/plasmaquick/Mainpage.dox @@ -7,11 +7,16 @@ It should not be used directly, however some classes are exposed to Plasma as at Namely: - AppletInterface - ContainmentInterface - which are exposed as "Plasmoid" for applets and containments respectively. QML applets should import org.kde.plasma.plasmoid 2.0 in order to access this attached object + + - WallpaperInterface +which is exposed as to wallpapers as the attached propety "wallpaper". +It does not require any special imports + + */ // DOXYGEN_SET_PROJECT_NAME = Plasma diff --git a/src/scriptengines/qml/plasmoid/wallpaperinterface.h b/src/scriptengines/qml/plasmoid/wallpaperinterface.h index 622e7585e..7eaff3b93 100644 --- a/src/scriptengines/qml/plasmoid/wallpaperinterface.h +++ b/src/scriptengines/qml/plasmoid/wallpaperinterface.h @@ -37,6 +37,13 @@ class ConfigPropertyMap; class QmlObject; } +/** + * @class WallpaperInterface + * + * @brief This class is exposed to wallpapers as the attached property "wallpaper" + * + * + */ class WallpaperInterface : public QQuickItem { Q_OBJECT