Fix malformed doc comments

Most of these are forgotten :'s and similar details which gtk-doc now warns about.
rightpeter · Apr 13, 2012 · 050cba6 · 050cba6
1 parent da755ad
commit 050cba6
Show file tree

Hide file tree

Showing 38 changed files with 87 additions and 98 deletions.
diff --git a/gdk/gdkdisplay.c b/gdk/gdkdisplay.c
@@ -1603,7 +1603,7 @@ gdk_display_request_selection_notification (GdkDisplay *display,
 }
 
 /**
- * gdk_display_supports_clipboard_persistence
+ * gdk_display_supports_clipboard_persistence:
  * @display: a #GdkDisplay
  *
  * Returns whether the speicifed display supports clipboard
@@ -1624,7 +1624,7 @@ gdk_display_supports_clipboard_persistence (GdkDisplay *display)
 }
 
 /**
- * gdk_display_store_clipboard
+ * gdk_display_store_clipboard:
  * @display:          a #GdkDisplay
  * @clipboard_window: a #GdkWindow belonging to the clipboard owner
  * @time_:            a timestamp

diff --git a/gdk/gdkevents.c b/gdk/gdkevents.c
@@ -170,15 +170,15 @@ _gdk_event_queue_insert_after (GdkDisplay *display,
 }
 
 /**
- * _gdk_event_queue_insert_after:
+ * _gdk_event_queue_insert_before:
  * @display: a #GdkDisplay
- * @sibling: Append after this event.
- * @event: Event to append.
+ * @sibling: Append before this event
+ * @event: Event to prepend
  *
- * Appends an event before the specified event, or if it isn't in
- * the queue, onto the tail of the event queue.
+ * Prepends an event before the specified event, or if it isn't in
+ * the queue, onto the head of the event queue.
  *
- * Returns: the newly appended list node.
+ * Returns: the newly prepended list node.
  *
  * Since: 2.16
  */

diff --git a/gtk/deprecated/gtkcolorsel.c b/gtk/deprecated/gtkcolorsel.c
@@ -333,7 +333,7 @@ gtk_color_selection_class_init (GtkColorSelectionClass *klass)
                                                          GTK_PARAM_READWRITE));
 
   /**
-   * GtkColorSelection:current-color
+   * GtkColorSelection:current-color:
    *
    * The current GdkColor color.
    *
@@ -355,7 +355,7 @@ gtk_color_selection_class_init (GtkColorSelectionClass *klass)
                                                       GTK_PARAM_READWRITE));
 
   /**
-   * GtkColorSelection:current-rgba
+   * GtkColorSelection:current-rgba:
    *
    * The current RGBA color.
    *

diff --git a/gtk/gtkbbox.c b/gtk/gtkbbox.c
@@ -391,7 +391,7 @@ gtk_button_box_get_child_secondary (GtkButtonBox *widget,
 }
 
 /**
- * gtk_button_box_set_child_secondary
+ * gtk_button_box_set_child_secondary:
  * @widget: a #GtkButtonBox
  * @child: a child of @widget
  * @is_secondary: if %TRUE, the @child appears in a secondary group of the

diff --git a/gtk/gtkcalendar.c b/gtk/gtkcalendar.c
@@ -610,7 +610,7 @@ gtk_calendar_class_init (GtkCalendarClass *class)
 
 
   /**
-   * GtkCalendar:inner-border
+   * GtkCalendar:inner-border:
    *
    * The spacing around the day/week headers and main area.
    */
@@ -622,7 +622,7 @@ gtk_calendar_class_init (GtkCalendarClass *class)
                                                              GTK_PARAM_READABLE));
 
   /**
-   * GtkCalndar:vertical-separation
+   * GtkCalndar:vertical-separation:
    *
    * Separation between day headers and main area.
    */
@@ -634,7 +634,7 @@ gtk_calendar_class_init (GtkCalendarClass *class)
                                                              GTK_PARAM_READABLE));
 
   /**
-   * GtkCalendar:horizontal-separation
+   * GtkCalendar:horizontal-separation:
    *
    * Separation between week headers and main area.
    */

diff --git a/gtk/gtkcellarea.c b/gtk/gtkcellarea.c
@@ -2335,7 +2335,7 @@ gtk_cell_area_attribute_disconnect (GtkCellArea        *area,
 }
 
 /**
- * gtk_cell_area_apply_attributes
+ * gtk_cell_area_apply_attributes:
  * @area: a #GtkCellArea
  * @tree_model: the #GtkTreeModel to pull values from
  * @iter: the #GtkTreeIter in @tree_model to apply values for

diff --git a/gtk/gtkcellrenderertext.c b/gtk/gtkcellrenderertext.c
@@ -691,7 +691,7 @@ gtk_cell_renderer_text_class_init (GtkCellRendererTextClass *class)
                 P_("Whether this tag affects the alignment mode"));
 
   /**
-   * GtkCellRendererText::edited
+   * GtkCellRendererText::edited:
    * @renderer: the object which received the signal
    * @path: the path identifying the edited cell
    * @new_text: the new text

diff --git a/gtk/gtkcellview.c b/gtk/gtkcellview.c
@@ -192,7 +192,7 @@ gtk_cell_view_class_init (GtkCellViewClass *klass)
                                                         GTK_PARAM_WRITABLE));
 
   /**
-   * GtkCellView:background-gdk
+   * GtkCellView:background-gdk:
    *
    * The background color as a #GdkColor
    *
@@ -206,7 +206,7 @@ gtk_cell_view_class_init (GtkCellViewClass *klass)
                                                       GDK_TYPE_COLOR,
                                                       GTK_PARAM_READWRITE | G_PARAM_DEPRECATED));
   /**
-   * GtkCellView:background-rgba
+   * GtkCellView:background-rgba:
    *
    * The background color as a #GdkRGBA
    *
@@ -221,7 +221,7 @@ gtk_cell_view_class_init (GtkCellViewClass *klass)
                                                       GTK_PARAM_READWRITE));
 
   /**
-   * GtkCellView:model
+   * GtkCellView:model:
    *
    * The model for cell view
    *
@@ -237,7 +237,7 @@ gtk_cell_view_class_init (GtkCellViewClass *klass)
 
 
   /**
-   * GtkCellView:cell-area
+   * GtkCellView:cell-area:
    *
    * The #GtkCellArea rendering cells
    *
@@ -255,7 +255,7 @@ gtk_cell_view_class_init (GtkCellViewClass *klass)
 							 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
 
   /**
-   * GtkCellView:cell-area-context
+   * GtkCellView:cell-area-context:
    *
    * The #GtkCellAreaContext used to compute the geometry of the cell view.
    *
@@ -280,7 +280,7 @@ gtk_cell_view_class_init (GtkCellViewClass *klass)
 							 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
 
   /**
-   * GtkCellView:draw-sensitive
+   * GtkCellView:draw-sensitive:
    *
    * Whether all cells should be draw as sensitive for this view regardless
    * of the actual cell properties (used to make menus with submenus appear
@@ -298,7 +298,7 @@ gtk_cell_view_class_init (GtkCellViewClass *klass)
 							  GTK_PARAM_READWRITE));
 
   /**
-   * GtkCellView:fit-model
+   * GtkCellView:fit-model:
    *
    * Whether the view should request enough space to always fit
    * the size of every row in the model (used by the combo box to

diff --git a/gtk/gtkclipboard.c b/gtk/gtkclipboard.c
@@ -1816,17 +1816,17 @@ gtk_clipboard_wait_is_uris_available (GtkClipboard *clipboard)
 }
 
 /**
- * gtk_clipboard_wait_for_targets
+ * gtk_clipboard_wait_for_targets:
  * @clipboard: a #GtkClipboard
  * @targets: (out) (array length=n_targets) (transfer container): location
  *           to store an array of targets. The result stored here must
  *           be freed with g_free().
  * @n_targets: location to store number of items in @targets.
  *
  * Returns a list of targets that are present on the clipboard, or %NULL
- * if there aren't any targets available. The returned list must be 
+ * if there aren't any targets available. The returned list must be
  * freed with g_free().
- * This function waits for the data to be received using the main 
+ * This function waits for the data to be received using the main
  * loop, so events, timeouts, etc, may be dispatched during the wait.
  *
  * Return value: %TRUE if any targets are present on the clipboard,

diff --git a/gtk/gtkcsssection.c b/gtk/gtkcsssection.c
@@ -192,11 +192,11 @@ gtk_css_section_get_parent (const GtkCssSection *section)
  * @section: the section
  *
  * Gets the file that @section was parsed from. If no such file exists,
- * for example because the CSS was loaded via 
+ * for example because the CSS was loaded via
  * @gtk_css_provider_load_from_data(), then %NULL is returned.
  *
- * Returns: the #GFile that @section was parsed from or %NULL if
- *   @section was parsed from other data.
+ * Returns: (transfer none): the #GFile that @section was parsed from
+ *     or %NULL if @section was parsed from other data
  *
  * Since: 3.2
  **/

diff --git a/gtk/gtkcsssection.h b/gtk/gtkcsssection.h
@@ -26,7 +26,7 @@ G_BEGIN_DECLS
 #define GTK_TYPE_CSS_SECTION         (gtk_css_section_get_type ())
 
 /**
- * GtkCssSection:
+ * GtkCssSectionType:
  * @GTK_CSS_SECTION_DOCUMENT: The section describes a complete document.
  *   This section time is the only one where gtk_css_section_get_parent()
  *   might return %NULL.

diff --git a/gtk/gtkentry.c b/gtk/gtkentry.c
@@ -942,7 +942,7 @@ gtk_entry_class_init (GtkEntryClass *class)
                                                          GTK_PARAM_READWRITE));
 
   /**
-   * GtkEntry:caps-lock-warning
+   * GtkEntry:caps-lock-warning:
    *
    * Whether password entries will show a warning when Caps Lock is on.
    *

diff --git a/gtk/gtkentrycompletion.c b/gtk/gtkentrycompletion.c
@@ -1708,7 +1708,7 @@ gtk_entry_completion_cursor_on_match (GtkEntryCompletion *completion,
  * Note that a text column must have been set for this function to work,
  * see gtk_entry_completion_set_text_column() for details. 
  *
- * Returns: (transfer: full): The common prefix all rows starting with @key
+ * Returns: (transfer full): The common prefix all rows starting with @key
  *   or %NULL if no row matches @key.
  *
  * Since: 3.4

diff --git a/gtk/gtkenums.h b/gtk/gtkenums.h
@@ -90,7 +90,7 @@ typedef enum
 } GtkArrowPlacement;
 
 /**
- * GtkArrowType
+ * GtkArrowType:
  * @GTK_ARROW_UP: Represents an upward pointing arrow.
  * @GTK_ARROW_DOWN: Represents a downward pointing arrow.
  * @GTK_ARROW_LEFT: Represents a left pointing arrow.

diff --git a/gtk/gtkfilechooser.c b/gtk/gtkfilechooser.c
@@ -554,7 +554,7 @@ gtk_file_chooser_default_init (GtkFileChooserInterface *iface)
   GType iface_type = G_TYPE_FROM_INTERFACE (iface);
 
   /**
-   * GtkFileChooser::current-folder-changed
+   * GtkFileChooser::current-folder-changed:
    * @chooser: the object which received the signal.
    *
    * This signal is emitted when the current folder in a #GtkFileChooser
@@ -580,7 +580,7 @@ gtk_file_chooser_default_init (GtkFileChooserInterface *iface)
 		G_TYPE_NONE, 0);
 
   /**
-   * GtkFileChooser::selection-changed
+   * GtkFileChooser::selection-changed:
    * @chooser: the object which received the signal.
    *
    * This signal is emitted when there is a change in the set of selected files
@@ -607,7 +607,7 @@ gtk_file_chooser_default_init (GtkFileChooserInterface *iface)
 		G_TYPE_NONE, 0);
 
   /**
-   * GtkFileChooser::update-preview
+   * GtkFileChooser::update-preview:
    * @chooser: the object which received the signal.
    *
    * This signal is emitted when the preview in a file chooser should be
@@ -641,7 +641,7 @@ gtk_file_chooser_default_init (GtkFileChooserInterface *iface)
 		G_TYPE_NONE, 0);
 
   /**
-   * GtkFileChooser::file-activated
+   * GtkFileChooser::file-activated:
    * @chooser: the object which received the signal.
    *
    * This signal is emitted when the user "activates" a file in the file

diff --git a/gtk/gtkfilefilter.c b/gtk/gtkfilefilter.c
@@ -20,6 +20,7 @@
  * SECTION:gtkfilefilter
  * @Short_description: A filter for selecting a file subset
  * @Title: GtkFileFilter
+ * @see_also: #GtkFileChooser
  *
  * A GtkFileFilter can be used to restrict the files being shown in a
  * #GtkFileChooser. Files can be filtered based on their name (with
@@ -63,8 +64,6 @@
  * </example>
  * </para>
  * </refsect2>
- *
- * @see_also: #GtkFileChooser
  */
 
 #include "config.h"

diff --git a/gtk/gtkfilefilter.h b/gtk/gtkfilefilter.h
@@ -61,7 +61,7 @@ typedef enum {
  * The type of function that is used with custom filters, see
  * gtk_file_filter_add_custom().
  *
- * @Returns: %TRUE if the file should be displayed
+ * Returns: %TRUE if the file should be displayed
  */
 typedef gboolean (*GtkFileFilterFunc) (const GtkFileFilterInfo *filter_info,
 				       gpointer                 data);

diff --git a/gtk/gtkiconfactory.c b/gtk/gtkiconfactory.c
@@ -2146,7 +2146,7 @@ gtk_icon_source_set_filename (GtkIconSource *source,
 }
 
 /**
- * gtk_icon_source_set_icon_name
+ * gtk_icon_source_set_icon_name:
  * @source: a #GtkIconSource
  * @icon_name: (allow-none): name of icon to use
  *

diff --git a/gtk/gtkicontheme.c b/gtk/gtkicontheme.c
@@ -429,7 +429,7 @@ gtk_icon_theme_class_init (GtkIconThemeClass *klass)
   gobject_class->finalize = gtk_icon_theme_finalize;
 
 /**
- * GtkIconTheme::changed
+ * GtkIconTheme::changed:
  * @icon_theme: the icon theme
  * 
  * Emitted when the current icon theme is switched or GTK+ detects

diff --git a/gtk/gtklinkbutton.c b/gtk/gtklinkbutton.c
@@ -163,9 +163,9 @@ gtk_link_button_class_init (GtkLinkButtonClass *klass)
   klass->activate_link = gtk_link_button_activate_link;
 
   /**
-   * GtkLinkButton:uri
-   * 
-   * The URI bound to this button. 
+   * GtkLinkButton:uri:
+   *
+   * The URI bound to this button.
    *
    * Since: 2.10
    */
@@ -177,8 +177,8 @@ gtk_link_button_class_init (GtkLinkButtonClass *klass)
   				   			NULL,
   				   			G_PARAM_READWRITE));
   /**
-   * GtkLinkButton:visited
-   * 
+   * GtkLinkButton:visited:
+   *
    * The 'visited' state of this button. A visited link is drawn in a
    * different color.
    *

diff --git a/gtk/gtklockbutton.c b/gtk/gtklockbutton.c
@@ -504,7 +504,7 @@ gtk_lock_button_new (GPermission *permission)
  *
  * Obtains the #GPermission object that controls @button.
  *
- * Returns: the #GPermission of @button
+ * Returns: (transfer none): the #GPermission of @button
  *
  * Since: 3.2
  */

diff --git a/gtk/gtkmenu.c b/gtk/gtkmenu.c
@@ -753,7 +753,7 @@ gtk_menu_class_init (GtkMenuClass *class)
                                                                GTK_PARAM_READWRITE));
 
  /**
-  * GtkMenu:arrow-scaling
+  * GtkMenu:arrow-scaling:
   *
   * Arbitrary constant to scale down the size of the scroll arrow.
   *
@@ -2000,7 +2000,7 @@ gtk_menu_real_can_activate_accel (GtkWidget *widget,
 }
 
 /**
- * gtk_menu_set_accel_path
+ * gtk_menu_set_accel_path:
  * @menu:       a valid #GtkMenu
  * @accel_path: (allow-none): a valid accelerator path
  *
@@ -2043,7 +2043,7 @@ gtk_menu_set_accel_path (GtkMenu     *menu,
 }
 
 /**
- * gtk_menu_get_accel_path
+ * gtk_menu_get_accel_path:
  * @menu: a valid #GtkMenu
  *
  * Retrieves the accelerator path set on the menu.