[gtk+/gtk-2-18] Doc fixes



commit 314fede98a786619892ded7b7a0885e626a0869e
Author: Matthias Clasen <mclasen redhat com>
Date:   Mon Jan 11 17:16:54 2010 -0500

    Doc fixes

 docs/reference/gtk/gtk-sections.txt |    1 -
 gtk/gtkclipboard.c                  |   21 +++++++++------------
 gtk/gtkiconview.c                   |   14 +++++++-------
 gtk/gtktoolitem.c                   |   20 ++++++++++----------
 4 files changed, 26 insertions(+), 30 deletions(-)
---
diff --git a/docs/reference/gtk/gtk-sections.txt b/docs/reference/gtk/gtk-sections.txt
index 3e4d490..8bba588 100644
--- a/docs/reference/gtk/gtk-sections.txt
+++ b/docs/reference/gtk/gtk-sections.txt
@@ -2633,7 +2633,6 @@ gtk_message_dialog_get_type
 GtkInfoBar
 gtk_info_bar_new
 gtk_info_bar_new_with_buttons
-gtk_info_bar_set_contents
 gtk_info_bar_add_action_widget
 gtk_info_bar_add_button
 gtk_info_bar_add_buttons
diff --git a/gtk/gtkclipboard.c b/gtk/gtkclipboard.c
index c9e9a2c..8cdb92f 100644
--- a/gtk/gtkclipboard.c
+++ b/gtk/gtkclipboard.c
@@ -309,20 +309,17 @@ gtk_clipboard_get_for_display (GdkDisplay *display,
 
 
 /**
- * gtk_clipboard_get():
- * @selection: a #GdkAtom which identifies the clipboard
- *             to use.
- * 
+ * gtk_clipboard_get:
+ * @selection: a #GdkAtom which identifies the clipboard to use
+ *
  * Returns the clipboard object for the given selection.
  * See gtk_clipboard_get_for_display() for complete details.
- * 
- * Return value: the appropriate clipboard object. If no
- *             clipboard already exists, a new one will
- *             be created. Once a clipboard object has
- *             been created, it is persistent and, since
- *             it is owned by GTK+, must not be freed or
- *             unrefd.
- **/
+ *
+ * Return value: the appropriate clipboard object.
+ *     If no clipboard already exists, a new one will becreated.
+ *     Once a clipboard object has been created, it is persistent
+ *     and, since it is owned by GTK+, must not be freed or unreffed.
+ */
 GtkClipboard *
 gtk_clipboard_get (GdkAtom selection)
 {
diff --git a/gtk/gtkiconview.c b/gtk/gtkiconview.c
index bb6ba29..f5ffaf1 100644
--- a/gtk/gtkiconview.c
+++ b/gtk/gtkiconview.c
@@ -6272,19 +6272,19 @@ gtk_icon_view_get_margin (GtkIconView *icon_view)
 /**
  * gtk_icon_view_set_item_padding:
  * @icon_view: a #GtkIconView
- * @column_spacing: the item padding
- * 
- * Sets the ::item-padding property which specifies the padding 
+ * @item_padding: the item padding
+ *
+ * Sets the #GtkIconView::item-padding property which specifies the padding
  * around each of the icon view's items.
  *
  * Since: 2.18
  */
-void 
+void
 gtk_icon_view_set_item_padding (GtkIconView *icon_view,
 				gint         item_padding)
 {
   g_return_if_fail (GTK_IS_ICON_VIEW (icon_view));
-  
+
   if (icon_view->priv->item_padding != item_padding)
     {
       icon_view->priv->item_padding = item_padding;
@@ -6292,9 +6292,9 @@ gtk_icon_view_set_item_padding (GtkIconView *icon_view,
       gtk_icon_view_stop_editing (icon_view, TRUE);
       gtk_icon_view_invalidate_sizes (icon_view);
       gtk_icon_view_queue_layout (icon_view);
-      
+
       g_object_notify (G_OBJECT (icon_view), "item-padding");
-    }  
+    }
 }
 
 /**
diff --git a/gtk/gtktoolitem.c b/gtk/gtktoolitem.c
index 7393f7e..8e8459c 100644
--- a/gtk/gtktoolitem.c
+++ b/gtk/gtktoolitem.c
@@ -1277,25 +1277,25 @@ gtk_tool_item_get_proxy_menu_item (GtkToolItem *tool_item,
 }
 
 /**
- * gtk_tool_item_rebuild_menu()
+ * gtk_tool_item_rebuild_menu:
  * @tool_item: a #GtkToolItem
- * 
+ *
  * Calling this function signals to the toolbar that the
  * overflow menu item for @tool_item has changed. If the
  * overflow menu is visible when this function it called,
  * the menu will be rebuilt.
  *
  * The function must be called when the tool item
- * changes what it will do in response to the "create_menu_proxy"
- * signal.
- * 
+ * changes what it will do in response to the
+ * #GtkToolItem::create-menu-proxy signal.
+ *
  * Since: 2.6
- **/
+ */
 void
 gtk_tool_item_rebuild_menu (GtkToolItem *tool_item)
 {
   GtkWidget *widget;
-  
+
   g_return_if_fail (GTK_IS_TOOL_ITEM (tool_item));
 
   widget = GTK_WIDGET (tool_item);
@@ -1309,13 +1309,13 @@ gtk_tool_item_rebuild_menu (GtkToolItem *tool_item)
  * @tool_item: a #GtkToolItem
  * @menu_item_id: a string used to identify @menu_item
  * @menu_item: a #GtkMenuItem to be used in the overflow menu
- * 
+ *
  * Sets the #GtkMenuItem used in the toolbar overflow menu. The
  * @menu_item_id is used to identify the caller of this function and
  * should also be used with gtk_tool_item_get_proxy_menu_item().
- * 
+ *
  * Since: 2.4
- **/
+ */
 void
 gtk_tool_item_set_proxy_menu_item (GtkToolItem *tool_item,
 				   const gchar *menu_item_id,



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