[gnome-desktop] Fix many documentation syntax warnings

[Colin Walters <walters src gnome org>]

commit 495acaa89c95d0691b7a53cae7c9230220a156fc
Author: Colin Walters <walters verbum org>
Date:   Mon Jul 16 11:33:45 2012 -0400

    Fix many documentation syntax warnings

 libgnome-desktop/gnome-bg.c             |    8 ++++----
 libgnome-desktop/gnome-pnp-ids.c        |    1 -
 libgnome-desktop/gnome-rr-labeler.c     |   16 ++++++++--------
 libgnome-desktop/gnome-rr-output-info.c |    2 --
 libgnome-desktop/gnome-rr.c             |   10 +++++-----
 5 files changed, 17 insertions(+), 20 deletions(-)
---
diff --git a/libgnome-desktop/gnome-bg.c b/libgnome-desktop/gnome-bg.c
index 824438e..b903e4a 100644
--- a/libgnome-desktop/gnome-bg.c
+++ b/libgnome-desktop/gnome-bg.c
@@ -1056,7 +1056,7 @@ gnome_bg_get_pixmap_size (GnomeBG   *bg,
  * @window: 
  * @width: 
  * @height:
- * @is_root:
+ * @root:
  *
  * Create a surface that can be set as background for @window. If @is_root is
  * TRUE, the surface created will be created by a temporary X server connection
@@ -1068,7 +1068,7 @@ gnome_bg_create_surface (GnomeBG	    *bg,
 		 	 GdkWindow   *window,
 			 int	     width,
 			 int	     height,
-			 gboolean     is_root)
+			 gboolean     root)
 {
 	int pm_width, pm_height;
 	cairo_surface_t *surface;
@@ -1088,7 +1088,7 @@ gnome_bg_create_surface (GnomeBG	    *bg,
 	/* has the side effect of loading and caching pixbuf only when in tile mode */
 	gnome_bg_get_pixmap_size (bg, width, height, &pm_width, &pm_height);
 	
-	if (is_root) {
+	if (root) {
 		surface = make_root_pixmap (gdk_window_get_screen (window),
 					   pm_width, pm_height);
 	}
@@ -1111,7 +1111,7 @@ gnome_bg_create_surface (GnomeBG	    *bg,
 		
 		pixbuf = gdk_pixbuf_new (GDK_COLORSPACE_RGB, FALSE, 8,
 					 width, height);
-		gnome_bg_draw (bg, pixbuf, gdk_window_get_screen (window), is_root);
+		gnome_bg_draw (bg, pixbuf, gdk_window_get_screen (window), root);
 		gdk_cairo_set_source_pixbuf (cr, pixbuf, 0, 0);
 		pixbuf_average_value (pixbuf, &average);
 		g_object_unref (pixbuf);
diff --git a/libgnome-desktop/gnome-pnp-ids.c b/libgnome-desktop/gnome-pnp-ids.c
index 7352f0d..f83f895 100644
--- a/libgnome-desktop/gnome-pnp-ids.c
+++ b/libgnome-desktop/gnome-pnp-ids.c
@@ -244,7 +244,6 @@ find_vendor (const char *pnp_id)
 
 /**
  * gnome_pnp_ids_get_pnp_id:
- *
  * @pnp_ids: a #GnomePnpIds object
  * @pnp_id: the PNP ID to look for
  *
diff --git a/libgnome-desktop/gnome-rr-labeler.c b/libgnome-desktop/gnome-rr-labeler.c
index 16de5e5..ea2ce70 100644
--- a/libgnome-desktop/gnome-rr-labeler.c
+++ b/libgnome-desktop/gnome-rr-labeler.c
@@ -418,13 +418,13 @@ setup_from_config (GnomeRRLabeler *labeler)
 
 /**
  * gnome_rr_labeler_new:
+ * @config: Configuration of the screens to label
+ *
  * Create a GUI element that will display colored labels on each connected monitor.
  * This is useful when users are required to identify which monitor is which, e.g. for
  * for configuring multiple monitors.
  * The labels will be shown by default, use gnome_rr_labeler_hide to hide them.
  *
- * @config: Configuration of the screens to label
- *
  * Returns: A new #GnomeRRLabeler
  */
 GnomeRRLabeler *
@@ -437,9 +437,9 @@ gnome_rr_labeler_new (GnomeRRConfig *config)
 
 /**
  * gnome_rr_labeler_show:
- * Show the labels.
- *
  * @labeler: A #GnomeRRLabeler
+ *
+ * Show the labels.
  */
 void
 gnome_rr_labeler_show (GnomeRRLabeler *labeler)
@@ -472,9 +472,9 @@ gnome_rr_labeler_show (GnomeRRLabeler *labeler)
 
 /**
  * gnome_rr_labeler_hide:
- * Hide ouput labels.
- *
  * @labeler: A #GnomeRRLabeler
+ *
+ * Hide ouput labels.
  */
 void
 gnome_rr_labeler_hide (GnomeRRLabeler *labeler)
@@ -500,11 +500,11 @@ gnome_rr_labeler_hide (GnomeRRLabeler *labeler)
 
 /**
  * gnome_rr_labeler_get_rgba_for_output:
- * Get the color used for the label on a given output (monitor).
- *
  * @labeler: A #GnomeRRLabeler
  * @output: Output device (i.e. monitor) to query
  * @rgba_out: (out): Color of selected monitor.
+ *
+ * Get the color used for the label on a given output (monitor).
  */
 void
 gnome_rr_labeler_get_rgba_for_output (GnomeRRLabeler *labeler, GnomeRROutputInfo *output, GdkRGBA *rgba_out)
diff --git a/libgnome-desktop/gnome-rr-output-info.c b/libgnome-desktop/gnome-rr-output-info.c
index 8936eed..b6db91b 100644
--- a/libgnome-desktop/gnome-rr-output-info.c
+++ b/libgnome-desktop/gnome-rr-output-info.c
@@ -96,7 +96,6 @@ void gnome_rr_output_info_set_active (GnomeRROutputInfo *self, gboolean active)
 
 /**
  * gnome_rr_output_info_get_geometry:
- *
  * @self: a #GnomeRROutputInfo
  * @x: (out) (allow-none):
  * @y: (out) (allow-none):
@@ -169,7 +168,6 @@ gboolean gnome_rr_output_info_is_connected (GnomeRROutputInfo *self)
 
 /**
  * gnome_rr_output_info_get_vendor:
- *
  * @self: a #GnomeRROutputInfo
  * @vendor: (out caller-allocates) (array fixed-size=4):
  */
diff --git a/libgnome-desktop/gnome-rr.c b/libgnome-desktop/gnome-rr.c
index 4a6384c..d84cdb2 100644
--- a/libgnome-desktop/gnome-rr.c
+++ b/libgnome-desktop/gnome-rr.c
@@ -947,11 +947,11 @@ rr_screen_weak_notify_cb (gpointer data, GObject *where_the_object_was)
 
 /**
  * gnome_rr_screen_new:
- * 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
  *
+ * Creates a unique #GnomeRRScreen instance for the specified @screen.
+ *
  * 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.
@@ -998,13 +998,13 @@ gnome_rr_screen_set_size (GnomeRRScreen *screen,
 
 /**
  * gnome_rr_screen_get_ranges:
- *
- * Get the ranges of the screen
  * @screen: a #GnomeRRScreen
  * @min_width: (out): the minimum width
  * @max_width: (out): the maximum width
  * @min_height: (out): the minimum height
  * @max_height: (out): the maximum height
+ *
+ * Get the ranges of the screen
  */
 void
 gnome_rr_screen_get_ranges (GnomeRRScreen *screen,
@@ -1869,7 +1869,7 @@ out:
 }
 
 /**
- * gnome_rr_screen_get_output_by_id:
+ * gnome_rr_screen_get_output_by_name:
  *
  * Returns: (transfer none): the output identified by @name
  */