add a fairly useful detail to the apidox on this method

svn path=/trunk/KDE/kdelibs/; revision=952061
2009-04-10 19:52:16 +00:00 · 2009-04-10 19:52:16 +00:00 · b2138871bd
commit b2138871bd
parent 9f7edec998
1 changed files with 2 additions and 1 deletions
--- a/wallpaper.h
+++ b/wallpaper.h
@ -413,7 +413,8 @@ class PLASMA_EXPORT Wallpaper : public QObject
         * @param key the name use in the cache for this image; if the image is specific
         *            to this wallpaper plugin, consider including the name() as part of
         *            the cache key to avoid collisions with other plugins.
-         * @param image the image to store in the cache
+         * @param image the image to store in the cache; passing in a null image will cause
+         *              the cached image to be removed from the cache
         *
         * @since 4.3
         **/