Add annotations and fix documentation syntax warnings

1 files changed, 33 insertions, 0 deletions

diff --git a/libmate-desktop/mate-rr-labeler.c b/libmate-desktop/mate-rr-labeler.c
index f7a2035..e65ced5 100644
--- a/libmate-desktop/mate-rr-labeler.c
+++ b/libmate-desktop/mate-rr-labeler.c
@@ -511,6 +511,17 @@ setup_from_config (MateRRLabeler *labeler)
 	create_label_windows (labeler);
 }
 
+/**
+ * mate_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 mate_rr_labeler_hide to hide them.
+ *
+ * Returns: A new #GnomeRRLabeler
+ */
 MateRRLabeler *
 mate_rr_labeler_new (MateRRConfig *config)
 {
@@ -519,6 +530,12 @@ mate_rr_labeler_new (MateRRConfig *config)
 	return g_object_new (MATE_TYPE_RR_LABELER, "config", config, NULL);
 }
 
+/**
+ * mate_rr_labeler_hide:
+ * @labeler: A #MateRRLabeler
+ *
+ * Hide ouput labels.
+ */
 void
 mate_rr_labeler_hide (MateRRLabeler *labeler)
 {
@@ -542,6 +559,14 @@ mate_rr_labeler_hide (MateRRLabeler *labeler)
 }
 
 #if GTK_CHECK_VERSION (3, 0, 0)
+/**
+ * mate_rr_labeler_get_rgba_for_output:
+ * @labeler: A #MateRRLabeler
+ * @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
 mate_rr_labeler_get_rgba_for_output (MateRRLabeler *labeler, MateRROutputInfo *output, GdkRGBA *color_out)
 {
@@ -569,6 +594,14 @@ mate_rr_labeler_get_rgba_for_output (MateRRLabeler *labeler, MateRROutputInfo *o
 }
 #endif
 
+/**
+ * mate_rr_labeler_get_color_for_output:
+ * @labeler: A #MateRRLabeler
+ * @output: Output device (i.e. monitor) to query
+ * @color_out: (out): Color of selected monitor.
+ *
+ * Get the color used for the label on a given output (monitor).
+ */
 void
 mate_rr_labeler_get_color_for_output (MateRRLabeler *labeler, MateRROutputInfo *output, GdkColor *color_out)
 {