From 02403bf1827fe7399114c2dca0e3165b33d16ebc Mon Sep 17 00:00:00 2001
From: Frederik Gladhorn <gladhorn@kde.org>
Date: Wed, 15 Apr 2009 22:30:15 +0000
Subject: [PATCH] add some api dox

svn path=/trunk/KDE/kdelibs/; revision=954563
---
 wallpaper.h | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/wallpaper.h b/wallpaper.h
index ddba1f52f..9bc3df852 100644
--- a/wallpaper.h
+++ b/wallpaper.h
@@ -200,7 +200,13 @@ class PLASMA_EXPORT Wallpaper : public QObject
         virtual void save(KConfigGroup &config);
 
         /**
-         * Returns widget for configuration dialog.
+         * Returns the widget used in the configuration dialog.
+         * Add the configuration interface of the wallpaper to this widget.
+         * To signal that settings have changed connect to
+         * settingsChanged(bool modified) in @p parent.
+         * @code connect(this, SIGNAL(settingsChanged(bool), parent, SLOT(settingsChanged(bool)))
+         * @endcode
+         * Emit settingsChanged(true) when the settings are changed and false when the original state is restored.
          */
         virtual QWidget *createConfigurationInterface(QWidget *parent);