[gtk+] Various documentation fixes



commit c5369356e86171c5d955cf9252e5c6bcde88d554
Author: Timm Bäder <mail baedert org>
Date:   Mon Feb 8 22:49:01 2016 +0100

    Various documentation fixes
    
    Always have Since: annotations at the very bottom, use the correct
    ClassName::signal-name/ClassName:property-name syntax, fix a few typos
    in type names, wrong function names, non-existing type names, etc.

 gtk/gtkfontchooserwidget.c |    4 ++--
 gtk/gtkgesture.c           |    4 ++--
 gtk/gtkgesturedrag.c       |    4 ++--
 gtk/gtkgesturelongpress.c  |    2 +-
 gtk/gtklabel.c             |    2 +-
 gtk/gtklistbox.c           |    2 +-
 gtk/gtkmodelbutton.c       |    2 +-
 gtk/gtknotebook.c          |    2 +-
 gtk/gtkshortcutsshortcut.c |    2 +-
 gtk/gtkshortcutswindow.c   |    2 +-
 gtk/gtkspinbutton.c        |    2 +-
 gtk/gtkstack.c             |    2 +-
 gtk/gtkstylecontext.c      |    2 +-
 13 files changed, 16 insertions(+), 16 deletions(-)
---
diff --git a/gtk/gtkfontchooserwidget.c b/gtk/gtkfontchooserwidget.c
index 0f62082..b7fbef1 100644
--- a/gtk/gtkfontchooserwidget.c
+++ b/gtk/gtkfontchooserwidget.c
@@ -69,11 +69,11 @@
  * To change the text which is shown in the preview area, use
  * gtk_font_chooser_set_preview_text().
  *
- * Since: 3.2
- *
  * # CSS nodes
  *
  * GtkFontChooserWidget has a single CSS node with name fontchooser.
+ *
+ * Since: 3.2
  */
 
 
diff --git a/gtk/gtkgesture.c b/gtk/gtkgesture.c
index 9fa1cf3..47fa3c5 100644
--- a/gtk/gtkgesture.c
+++ b/gtk/gtkgesture.c
@@ -54,8 +54,8 @@
  * target widget, and gestures that are attached to containers above the widget
  * get a chance to interact with the event before it reaches the target.
  *
- * After the capture phase, GTK+ emits the traditional #GtkWidget::button-press,
- * #GtkWidget::button-release, #GtkWidget::touch-event, etc signals. Gestures 
+ * After the capture phase, GTK+ emits the traditional #GtkWidget::button-press-event,
+ * #GtkWidget::button-release-event, #GtkWidget::touch-event, etc signals. Gestures
  * with the %GTK_PHASE_TARGET phase are fed events from the default #GtkWidget::event
  * handlers.
  *
diff --git a/gtk/gtkgesturedrag.c b/gtk/gtkgesturedrag.c
index 0c5a785..59fdc2a 100644
--- a/gtk/gtkgesturedrag.c
+++ b/gtk/gtkgesturedrag.c
@@ -25,8 +25,8 @@
  *
  * #GtkGestureDrag is a #GtkGesture implementation that recognizes drag
  * operations. The drag operation itself can be tracked throught the
- * #GtkGestureDrag:drag-begin, #GtkGestureDrag:drag-update and
- * #GtkGestureDrag:drag-end signals, or the relevant coordinates be
+ * #GtkGestureDrag::drag-begin, #GtkGestureDrag::drag-update and
+ * #GtkGestureDrag::drag-end signals, or the relevant coordinates be
  * extracted through gtk_gesture_drag_get_offset() and
  * gtk_gesture_drag_get_start_point().
  */
diff --git a/gtk/gtkgesturelongpress.c b/gtk/gtkgesturelongpress.c
index 405068d..8cbcce7 100644
--- a/gtk/gtkgesturelongpress.c
+++ b/gtk/gtkgesturelongpress.c
@@ -309,7 +309,7 @@ gtk_gesture_long_press_class_init (GtkGestureLongPressClass *klass)
    * @gesture: the object which received the signal
    *
    * This signal is emitted whenever a press moved too far, or was released
-   * before #GtkGestureLongPress:pressed happened.
+   * before #GtkGestureLongPress::pressed happened.
    *
    * Since: 3.14
    */
diff --git a/gtk/gtklabel.c b/gtk/gtklabel.c
index e1f55f6..c0b3777 100644
--- a/gtk/gtklabel.c
+++ b/gtk/gtklabel.c
@@ -208,7 +208,7 @@
  *
  * gtk_label_set_justify() sets how the lines in a label align
  * with one another. If you want to set how the label as a whole
- * aligns in its available space, see the #GtkWidget::halign and
+ * aligns in its available space, see the #GtkWidget:halign and
  * #GtkWidget:valign properties.
  *
  * The #GtkLabel:width-chars and #GtkLabel:max-width-chars properties
diff --git a/gtk/gtklistbox.c b/gtk/gtklistbox.c
index f2a35b8..59a46b8 100644
--- a/gtk/gtklistbox.c
+++ b/gtk/gtklistbox.c
@@ -3592,7 +3592,7 @@ gtk_list_box_row_get_activatable (GtkListBoxRow *row)
 
 /**
  * gtk_list_box_row_set_selectable:
- * @row: a #GTkListBoxrow
+ * @row: a #GtkListBoxRow
  * @selectable: %TRUE to mark the row as selectable
  *
  * Set the #GtkListBoxRow:selectable property for this row.
diff --git a/gtk/gtkmodelbutton.c b/gtk/gtkmodelbutton.c
index cbeab65..0e941c2 100644
--- a/gtk/gtkmodelbutton.c
+++ b/gtk/gtkmodelbutton.c
@@ -142,7 +142,7 @@
  * ╰── check
  * ]|
  *
- * Iconic model buttons (see #GtkModelButton::iconic) change the name of
+ * Iconic model buttons (see #GtkModelButton:iconic) change the name of
  * their main node to button and add a .model style class to it. The indicator
  * subnode is invisible in this case.
  */
diff --git a/gtk/gtknotebook.c b/gtk/gtknotebook.c
index a4d97ed..26de2bc 100644
--- a/gtk/gtknotebook.c
+++ b/gtk/gtknotebook.c
@@ -130,7 +130,7 @@
  * name arrow are placed as first and last child of the tabs node.
  *
  * The main node gets the .frame style class when the notebook
- * has a border (see gtk_notebook_set_has_border()).
+ * has a border (see gtk_notebook_set_show_border()).
  *
  * The header node gets one of the style class .top, .bottom,
  * .left or .right, depending on where the tabs are placed. For
diff --git a/gtk/gtkshortcutsshortcut.c b/gtk/gtkshortcutsshortcut.c
index cd44674..018322c 100644
--- a/gtk/gtkshortcutsshortcut.c
+++ b/gtk/gtkshortcutsshortcut.c
@@ -464,7 +464,7 @@ gtk_shortcuts_shortcut_class_init (GtkShortcutsShortcutClass *klass)
    * GtkShortcutsShortcut:accelerator:
    *
    * The accelerator(s) represented by this object. This property is used
-   * if #GtkShorcutsShortcut:shortcut-type is set to #GTK_SHORTCUT_ACCELERATOR.
+   * if #GtkShortcutsShortcut:shortcut-type is set to #GTK_SHORTCUT_ACCELERATOR.
    *
    * The syntax of this property is (an extension of) the syntax understood by
    * gtk_accelerator_parse(). Multiple accelerators can be specified by separating
diff --git a/gtk/gtkshortcutswindow.c b/gtk/gtkshortcutswindow.c
index 6edb4ee..109c17f 100644
--- a/gtk/gtkshortcutswindow.c
+++ b/gtk/gtkshortcutswindow.c
@@ -45,7 +45,7 @@
  * The recommended way to construct a GtkShortcutsWindow is with GtkBuilder,
  * by populating a #GtkShortcutsWindow with one or more #GtkShortcutsSection
  * objects, which contain #GtkShortcutsGroups that in turn contain objects of
- * class #GtkShortcutsShortcut or #GtkShortcutsGesture.
+ * class #GtkShortcutsShortcut.
  *
  * # A simple example:
  *
diff --git a/gtk/gtkspinbutton.c b/gtk/gtkspinbutton.c
index 7961dc9..e76a1e7 100644
--- a/gtk/gtkspinbutton.c
+++ b/gtk/gtkspinbutton.c
@@ -84,7 +84,7 @@
  * properties. Note that GtkSpinButton will by default make its entry
  * large enough to accomodate the lower and upper bounds of the adjustment,
  * which can lead to surprising results. Best practice is to set both
- * the #GtkEntry::width-chars and #GtkEntry::max-width-chars poperties
+ * the #GtkEntry:width-chars and #GtkEntry:max-width-chars poperties
  * to the desired number of characters to display in the entry.
  *
  * # CSS nodes
diff --git a/gtk/gtkstack.c b/gtk/gtkstack.c
index 998f08f..9438933 100644
--- a/gtk/gtkstack.c
+++ b/gtk/gtkstack.c
@@ -1690,7 +1690,7 @@ gtk_stack_get_transition_running (GtkStack *stack)
  * @interpolate_size: the new value
  *
  * Sets whether or not @stack will interpolate its size when
- * changing the visible child. If the #GtkStack::interpolate-size
+ * changing the visible child. If the #GtkStack:interpolate-size
  * property is set to %TRUE, @stack will interpolate its size between
  * the current one and the one it'll take after changing the
  * visible child, according to the set transition duration.
diff --git a/gtk/gtkstylecontext.c b/gtk/gtkstylecontext.c
index 7d5664a..bfb0948 100644
--- a/gtk/gtkstylecontext.c
+++ b/gtk/gtkstylecontext.c
@@ -2568,7 +2568,7 @@ gtk_style_context_get_background_color (GtkStyleContext *context,
  *
  * Since: 3.0
  *
- * Deprecated: 3.16: Use gtk_render_border() instead.
+ * Deprecated: 3.16: Use gtk_render_frame() instead.
  **/
 void
 gtk_style_context_get_border_color (GtkStyleContext *context,


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