[gtk+] Documentation fixes

[Matthias Clasen <matthiasc src gnome org>]

commit c396c523279d345cccaffa85e42149aa1efeddf9
Author: Matthias Clasen <mclasen redhat com>
Date:   Thu Jan 6 08:12:01 2011 -0500

    Documentation fixes

 gtk/gtkadjustment.h   |   60 ++++++++++++++++++++----------------------------
 gtk/gtkcomboboxtext.c |    5 ++-
 gtk/gtkwindow.c       |   10 ++++----
 3 files changed, 33 insertions(+), 42 deletions(-)
---
diff --git a/gtk/gtkadjustment.h b/gtk/gtkadjustment.h
index dafd8ce..1ea9de5 100644
--- a/gtk/gtkadjustment.h
+++ b/gtk/gtkadjustment.h
@@ -8,7 +8,7 @@
  *
  * This library is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the GNU
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
@@ -43,25 +43,15 @@ G_BEGIN_DECLS
 #define GTK_ADJUSTMENT_GET_CLASS(obj)        (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_ADJUSTMENT, GtkAdjustmentClass))
 
 
-typedef struct _GtkAdjustment	      GtkAdjustment;
+typedef struct _GtkAdjustment         GtkAdjustment;
 typedef struct _GtkAdjustmentPrivate  GtkAdjustmentPrivate;
 typedef struct _GtkAdjustmentClass    GtkAdjustmentClass;
 
 /**
  * GtkAdjustment:
- * @lower: the minimum value.
- * @upper: the maximum value.
- * @value: the current value.
- * @step_increment: the increment to use to make minor changes to the @value.
- *   In a #GtkScrollbar this increment is used when the mouse is clicked on the
- *   arrows at the top and bottom of the scrollbar, to scroll by a small amount.
- * @page_increment: the increment to use to make major changes to the @value.
- *   In a #GtkScrollbar this increment is used when the mouse is clicked in the
- *   trough, to scroll by a large amount.
- * @page_size: In a #GtkScrollbar this is the size of the area which is currently
- *   visible.
  *
- * The #GtkAdjustment struct contains the following fields.
+ * The #GtkAdjustment struct contains only private fields and
+ * should not be directly accessed.
  */
 struct _GtkAdjustment
 {
@@ -74,7 +64,7 @@ struct _GtkAdjustmentClass
 {
   GInitiallyUnownedClass parent_class;
 
-  void (* changed)	 (GtkAdjustment *adjustment);
+  void (* changed)       (GtkAdjustment *adjustment);
   void (* value_changed) (GtkAdjustment *adjustment);
 
   /* Padding for future expansion */
@@ -85,23 +75,23 @@ struct _GtkAdjustmentClass
 };
 
 
-GType	   gtk_adjustment_get_type		(void) G_GNUC_CONST;
-GtkAdjustment*   gtk_adjustment_new		(gdouble	  value,
-						 gdouble	  lower,
-						 gdouble	  upper,
-						 gdouble	  step_increment,
-						 gdouble	  page_increment,
-						 gdouble	  page_size);
+GType      gtk_adjustment_get_type              (void) G_GNUC_CONST;
+GtkAdjustment*   gtk_adjustment_new             (gdouble          value,
+                                                 gdouble          lower,
+                                                 gdouble          upper,
+                                                 gdouble          step_increment,
+                                                 gdouble          page_increment,
+                                                 gdouble          page_size);
 
-void	   gtk_adjustment_changed		(GtkAdjustment	 *adjustment);
-void	   gtk_adjustment_value_changed		(GtkAdjustment	 *adjustment);
-void	   gtk_adjustment_clamp_page		(GtkAdjustment	 *adjustment,
-						 gdouble	  lower,
-						 gdouble	  upper);
+void       gtk_adjustment_changed               (GtkAdjustment   *adjustment);
+void       gtk_adjustment_value_changed         (GtkAdjustment   *adjustment);
+void       gtk_adjustment_clamp_page            (GtkAdjustment   *adjustment,
+                                                 gdouble          lower,
+                                                 gdouble          upper);
 
-gdouble	   gtk_adjustment_get_value		(GtkAdjustment   *adjustment);
-void	   gtk_adjustment_set_value		(GtkAdjustment	 *adjustment,
-						 gdouble	  value);
+gdouble    gtk_adjustment_get_value             (GtkAdjustment   *adjustment);
+void       gtk_adjustment_set_value             (GtkAdjustment   *adjustment,
+                                                 gdouble          value);
 gdouble    gtk_adjustment_get_lower             (GtkAdjustment   *adjustment);
 void       gtk_adjustment_set_lower             (GtkAdjustment   *adjustment,
                                                  gdouble          lower);
@@ -120,11 +110,11 @@ void       gtk_adjustment_set_page_size         (GtkAdjustment   *adjustment,
 
 void       gtk_adjustment_configure             (GtkAdjustment   *adjustment,
                                                  gdouble          value,
-						 gdouble          lower,
-						 gdouble          upper,
-						 gdouble          step_increment,
-						 gdouble          page_increment,
-						 gdouble          page_size);
+                                                 gdouble          lower,
+                                                 gdouble          upper,
+                                                 gdouble          step_increment,
+                                                 gdouble          page_increment,
+                                                 gdouble          page_size);
 
 G_END_DECLS
 
diff --git a/gtk/gtkcomboboxtext.c b/gtk/gtkcomboboxtext.c
index a9a09a2..355e248 100644
--- a/gtk/gtkcomboboxtext.c
+++ b/gtk/gtkcomboboxtext.c
@@ -216,7 +216,8 @@ gtk_combo_box_text_append (GtkComboBoxText *combo_box,
 /**
  * gtk_combo_box_text_prepend:
  * @combo_box: A #GtkComboBox
- * @text: A string
+ * @id: (allow-none): a string ID for this value, or %NULL
+ * @text: a string
  *
  * Prepends @text to the list of strings stored in @combo_box.  If @id
  * is non-%NULL then it is used as the ID of the row.
@@ -239,7 +240,7 @@ gtk_combo_box_text_prepend (GtkComboBoxText *combo_box,
  * gtk_combo_box_text_insert:
  * @combo_box: A #GtkComboBoxText
  * @position: An index to insert @text
- * @id: a string ID for this value, or %NULL
+ * @id: (allow-none): a string ID for this value, or %NULL
  * @text: A string to display
  *
  * Inserts @text at @position in the list of strings stored in @combo_box.
diff --git a/gtk/gtkwindow.c b/gtk/gtkwindow.c
index 4fc7700..b92627a 100644
--- a/gtk/gtkwindow.c
+++ b/gtk/gtkwindow.c
@@ -861,7 +861,7 @@ gtk_window_class_init (GtkWindowClass *klass)
                                                          GTK_PARAM_READWRITE));
 
   /**
-   * GtkWindow: resize-grip-visible:
+   * GtkWindow:resize-grip-visible:
    *
    * Whether a corner resize grip is currently shown.
    *
@@ -5520,7 +5520,7 @@ update_grip_visibility (GtkWindow *window)
  *
  * Determines whether a resize grip is visible for the specified window.
  *
- * Returns %TRUE if a resize grip exists and is visible.
+ * Returns: %TRUE if a resize grip exists and is visible
  *
  * Since: 3.0
  */
@@ -5567,7 +5567,7 @@ gtk_window_resize_grip_is_visible (GtkWindow *window)
  *
  * Determines whether the window may have a resize grip.
  *
- * Returns: %TRUE if the window has a resize grip.
+ * Returns: %TRUE if the window has a resize grip
  *
  * Since: 3.0
  */
@@ -5583,12 +5583,12 @@ gtk_window_get_has_resize_grip (GtkWindow *window)
  * gtk_window_get_resize_grip_area:
  * @window: a #GtkWindow
  * @rect: a pointer to a #GdkRectangle which we should store the
- *     resize grip area.
+ *     resize grip area
  *
  * If a window has a resize grip, this will retrieve the grip
  * position, width and height into the specified #GdkRectangle.
  *
- * Returns: %TRUE if the resize grip's area was retrieved.
+ * Returns: %TRUE if the resize grip's area was retrieved
  *
  * Since: 3.0
  */