]> Pileus Git - ~andy/gtk/commitdiff
Doc fixups.
authorOwen Taylor <otaylor@redhat.com>
Tue, 9 Jan 2001 16:23:57 +0000 (16:23 +0000)
committerOwen Taylor <otaylor@src.gnome.org>
Tue, 9 Jan 2001 16:23:57 +0000 (16:23 +0000)
Tue Jan  9 11:20:48 2001  Owen Taylor  <otaylor@redhat.com>

* gtk/gtktreeview.[ch] gtktreemodelsort.[ch] gtknotebook.c
gdk/gdk-pixbuf.h: Doc fixups.

* gtk/gtkobject.h: Remove trailing , from enum

gdk-pixbuf/gdk-pixbuf.h
gtk/gtknotebook.c
gtk/gtkobject.h
gtk/gtktreemodelsort.c
gtk/gtktreemodelsort.h
gtk/gtktreeview.c
gtk/gtktreeview.h

index f089dcf900901ecd43077a5e0eb8296ccfde4e87..381bbc5387e85f9c8629b741ece5093d9845b9b5 100644 (file)
@@ -279,7 +279,7 @@ int                  gdk_pixbuf_frame_get_x_offset   (GdkPixbufFrame *frame);
 int                  gdk_pixbuf_frame_get_y_offset   (GdkPixbufFrame *frame);
 int                  gdk_pixbuf_frame_get_delay_time (GdkPixbufFrame *frame);
 GdkPixbufFrameAction gdk_pixbuf_frame_get_action     (GdkPixbufFrame *frame);
-GdkPixbufFrame      *gdk_pixbuf_frame_copy           (GdkPixbufFrame *frame);
+GdkPixbufFrame      *gdk_pixbuf_frame_copy           (GdkPixbufFrame *src);
 void                 gdk_pixbuf_frame_free           (GdkPixbufFrame *frame);
 GType                gdk_pixbuf_frame_get_type       (void) G_GNUC_CONST;
 #define              GDK_TYPE_PIXBUF_FRAME gdk_pixbuf_frame_get_type ()
index fecef3b6b8370ac038fe27a75e320af4622403f8..4c0994af459804567e4be937ceb09ff9e85ea725 100644 (file)
@@ -372,7 +372,6 @@ gtk_notebook_init (GtkNotebook *notebook)
 
 /**
  * gtk_notebook_new:
- * @void: 
  * 
  * Creates a new #GtkNotebook widget with no pages.
 
@@ -4099,22 +4098,21 @@ gtk_notebook_set_homogeneous_tabs (GtkNotebook *notebook,
 /**
  * gtk_notebook_set_tab_border:
  * @notebook: a #GtkNotebook
- * @tab_border: %TRUE if there should be a border around the
- *              tab labels.
+ * @border_width: width of the border around the tab labels.
  * 
- * Sets whether there should be a border around the tab labels
+ * Sets the width the border around the tab labels
  * in a notebook. This is equivalent to calling
- * gtk_notebook_set_tab_hborder (@notebook, @tab_border) followed
- * by gtk_noteobok_set_tab_vborder (@notebook, @tab_border).
+ * gtk_notebook_set_tab_hborder (@notebook, @border_width) followed
+ * by gtk_noteobok_set_tab_vborder (@notebook, @border_width).
  **/
 void
 gtk_notebook_set_tab_border (GtkNotebook *notebook,
-                            guint        tab_border)
+                            guint        border_width)
 {
   g_return_if_fail (GTK_IS_NOTEBOOK (notebook));
 
-  notebook->tab_hborder = tab_border;
-  notebook->tab_vborder = tab_border;
+  notebook->tab_hborder = border_width;
+  notebook->tab_vborder = border_width;
 
   if (GTK_WIDGET_VISIBLE (notebook) && notebook->show_tabs)
     gtk_widget_queue_resize (GTK_WIDGET (notebook));
@@ -4123,10 +4121,9 @@ gtk_notebook_set_tab_border (GtkNotebook *notebook,
 /**
  * gtk_notebook_set_tab_hborder:
  * @notebook: a #GtkNotebook
- * @tab_vborder: %TRUE if the notebook tabs should have
- *               a vertical border.
+ * @tab_hborder: width of the horizontal border of tab labels.
  * 
- * Sets whether the tabs should have a vertical border.
+ * Sets the width of the horizontal border of tab labels.
  **/
 void
 gtk_notebook_set_tab_hborder (GtkNotebook *notebook,
@@ -4146,10 +4143,9 @@ gtk_notebook_set_tab_hborder (GtkNotebook *notebook,
 /**
  * gtk_notebook_set_tab_vborder:
  * @notebook: a #GtkNotebook
- * @tab_vborder: %TRUE if the notebook tabs should have
- *               a vertical border.
+ * @tab_vborder: width of the vertical border of tab labels.
  * 
- * Sets whether the tabs should have a vertical border.
+ * Sets the width of the vertical border of tab labels.
  **/
 void
 gtk_notebook_set_tab_vborder (GtkNotebook *notebook,
@@ -4368,7 +4364,7 @@ gtk_notebook_set_tab_label (GtkNotebook *notebook,
  * gtk_notebook_set_tab_label_text:
  * @notebook: a #GtkNotebook
  * @child: the page
- * @tab_label: the label text
+ * @tab_text: the label text
  * 
  * Creates a new label and sets it as the tab label for the page
  * containing @child.
index 239c21d07a691a940c1a4d2b6dd207071274a9c3..a53f1d3d7d6caf89451a94cdcf420ab23356f2c4 100644 (file)
@@ -216,7 +216,7 @@ typedef enum
   GTK_ARG_WRITABLE      = G_PARAM_WRITABLE,
   GTK_ARG_CONSTRUCT     = G_PARAM_CONSTRUCT,
   GTK_ARG_CONSTRUCT_ONLY = G_PARAM_CONSTRUCT_ONLY,
-  GTK_ARG_CHILD_ARG     = 1 << 4,
+  GTK_ARG_CHILD_ARG     = 1 << 4
 } GtkArgFlags;
 #define        GTK_ARG_READWRITE       (GTK_ARG_READABLE | GTK_ARG_WRITABLE)
 void   gtk_object_get          (GtkObject      *object,
index 5b30458f4820d4ae80b1942f84acb27556ffb68e..138d5bbc4f2e2a9c967635c912e058ca57e93c3e 100644 (file)
@@ -324,13 +324,13 @@ gtk_tree_model_sort_set_model (GtkTreeModelSort *tree_model_sort,
 /**
  * gtk_tree_model_sort_convert_path:
  * @tree_model_sort: The #GtkTreeModelSort.
- * @path: A #GtkTreePath, relative to the child model.
+ * @child_path: A #GtkTreePath, relative to the child model.
  * 
- * Converts the @path to a new path, relative to the sorted position.  In other
- * words, the value found in the @tree_model_sort ->child_model at the @path, is
+ * Converts the @child_path to a new path, relative to the sorted position.  In other
+ * words, the value found in the @tree_model_sort ->child_model at the @child_path, is
  * identical to that found in the @tree_model_sort and the return value.
  * 
- * Return value: A new path, or NULL if @path does not exist in @tree_model_sort
+ * Return value: A new path, or NULL if @child_path does not exist in @tree_model_sort
  * ->child_model.
  **/
 GtkTreePath *
index 66a345377556926e6d04dce9e1a7a539b8b8a2b6..ac76d626e8cede14a7fb25c6695bf50184d02322 100644 (file)
@@ -77,7 +77,7 @@ GtkTreeModel *gtk_tree_model_sort_new_with_model (GtkTreeModel      *child_model
                                                  GValueCompareFunc  func,
                                                  gint               sort_col);
 void          gtk_tree_model_sort_set_model      (GtkTreeModelSort  *tree_model_sort,
-                                                 GtkTreeModel      *model);
+                                                 GtkTreeModel      *child_model);
 GtkTreePath  *gtk_tree_model_sort_convert_path   (GtkTreeModelSort  *tree_model_sort,
                                                  GtkTreePath       *child_path);
 
index ccf056ff24cebff10a645641fc79de12cbcce3ff..d7c121fa0f8ad5f191aaa93fa8686a1cd46e0288 100644 (file)
@@ -3288,7 +3288,7 @@ gtk_tree_view_columns_autosize (GtkTreeView *tree_view)
  **/
 void
 gtk_tree_view_set_headers_clickable (GtkTreeView *tree_view,
-                                 gboolean   setting)
+                                    gboolean   setting)
 {
   GList *list;
 
index c2870d45cd50f7a683e6c359185e66a1aaf7ec72..58709893ffe9949b50bb684adabf022a344fc6d7 100644 (file)
@@ -78,7 +78,7 @@ void                   gtk_tree_view_set_headers_visible (GtkTreeView        *tr
                                                          gboolean            headers_visible);
 void                   gtk_tree_view_columns_autosize    (GtkTreeView        *tree_view);
 void                   gtk_tree_view_set_headers_clickable (GtkTreeView        *tree_view,
-                                                            gboolean            active);
+                                                            gboolean            setting);
 gint                   gtk_tree_view_append_column       (GtkTreeView        *tree_view,
                                                          GtkTreeViewColumn  *column);
 gint                   gtk_tree_view_remove_column       (GtkTreeView        *tree_view,