gnome-desktop r5354 - trunk/libgnome-desktop

[halfline svn gnome org]

Author: halfline
Date: Mon Jan 19 22:57:43 2009
New Revision: 5354
URL: http://svn.gnome.org/viewvc/gnome-desktop?rev=5354&view=rev

Log:
Add docstring for gnome_bg_set_pixmap_as_root

I'm going to be adding a parallel api that references
this function in the docs, so we should document this
one as well.

Modified:
   trunk/libgnome-desktop/ChangeLog
   trunk/libgnome-desktop/gnome-bg.c

Modified: trunk/libgnome-desktop/gnome-bg.c
==============================================================================
--- trunk/libgnome-desktop/gnome-bg.c	(original)
+++ trunk/libgnome-desktop/gnome-bg.c	Mon Jan 19 22:57:43 2009
@@ -1097,12 +1097,18 @@
 			 (guchar *) &pixmap_id, 1);
 }
 
-/* Set the root pixmap, and properties pointing to it. We
+/**
+ * gnome_bg_set_pixmap_as_root:
+ * @screen: the #GdkScreen to change root background on
+ * @pixmap: the #GdkPixmap to set root background from
+ *
+ * Set the root pixmap, and properties pointing to it. We
  * do this atomically with a server grab to make sure that
  * we won't leak the pixmap if somebody else it setting
  * it at the same time. (This assumes that they follow the
- * same conventions we do)
- */
+ * same conventions we do).  @pixmap should come from a call
+ * to gnome_bg_create_pixmap().
+ **/
 void
 gnome_bg_set_pixmap_as_root (GdkScreen *screen, GdkPixmap *pixmap)
 {