[gnome-desktop] Update the docs for gnome_rr_screen_new()



commit a795e4a631f08d7d10c562a7046d825f542f0e1d
Author: Federico Mena Quintero <federico gnome org>
Date:   Tue Jan 10 17:43:56 2012 -0600

    Update the docs for gnome_rr_screen_new()
    
    Signed-off-by: Federico Mena Quintero <federico gnome org>

 libgnome-desktop/gnome-rr.c |    7 ++++---
 1 files changed, 4 insertions(+), 3 deletions(-)
---
diff --git a/libgnome-desktop/gnome-rr.c b/libgnome-desktop/gnome-rr.c
index 628e1a1..c7afd8e 100644
--- a/libgnome-desktop/gnome-rr.c
+++ b/libgnome-desktop/gnome-rr.c
@@ -946,13 +946,14 @@ rr_screen_weak_notify_cb (gpointer data, GObject *where_the_object_was)
 
 /**
  * gnome_rr_screen_new:
- * Creates a new #GnomeRRScreen instance
+ * Creates a unique #GnomeRRScreen instance for the specified @screen.
  *
  * @screen: the #GdkScreen on which to operate
  * @error: will be set if XRandR is not supported
  *
- * Returns: a new #GnomeRRScreen instance or NULL if screen could not be created,
- * for instance if the driver does not support Xrandr 1.2
+ * Returns: a unique #GnomeRRScreen instance, specific to the @screen, or NULL
+ * if this could not be created, for instance if the driver does not support
+ * Xrandr 1.2.  Each #GdkScreen thus has a single instance of #GnomeRRScreen.
  */
 GnomeRRScreen *
 gnome_rr_screen_new (GdkScreen *screen,



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]