GNOME.org
 

[gtk+] Documentation: Correct references to properties.

commit a0b4ab109dccb0d523082de928948e71b0681ef1
Author: Murray Cumming <murrayc murrayc com>
Date:   Wed Feb 15 11:43:33 2012 +0100

    Documentation: Correct references to properties.
    
    These should use :, not ::, though signals would use ::.
    See
    http://developer.gnome.org/gtk-doc-manual/unstable/documenting_syntax.html.en
    and
    http://developer.gnome.org/gtk-doc-manual/unstable/documenting_symbols.html.en

 gtk/deprecated/gtkcolorsel.c |    2 +-
 gtk/deprecated/gtkhbox.c     |    2 +-
 gtk/deprecated/gtkvbox.c     |    2 +-
 gtk/gtkactivatable.c         |    4 ++--
 gtk/gtkactivatable.h         |    4 ++--
 gtk/gtkappchooserbutton.c    |    6 +++---
 gtk/gtkbbox.c                |    4 ++--
 gtk/gtkcomboboxtext.c        |    2 +-
 gtk/gtkentry.c               |    2 +-
 gtk/gtkiconview.c            |    2 +-
 gtk/gtkoverlay.c             |    6 +++---
 gtk/gtkprintoperation.c      |    6 +++---
 gtk/gtkprintunixdialog.c     |    8 ++++----
 gtk/gtktoolitem.c            |    2 +-
 gtk/gtkwidget.c              |    2 +-
 15 files changed, 27 insertions(+), 27 deletions(-)
---
diff --git a/gtk/deprecated/gtkcolorsel.c b/gtk/deprecated/gtkcolorsel.c
index a0b8377..66b1018 100644
--- a/gtk/deprecated/gtkcolorsel.c
+++ b/gtk/deprecated/gtkcolorsel.c
@@ -3071,7 +3071,7 @@ gtk_color_selection_palette_to_string (const GdkColor *colors,
  * tries to modify the palette in a color selection.
  *
  * This function should save the new palette contents, and update
- * the #GtkSettings::gtk-color-palette GtkSettings property so all
+ * the #GtkSettings:gtk-color-palette GtkSettings property so all
  * GtkColorSelection widgets will be modified.
  *
  * Return value: the previous change palette hook (that was replaced)
diff --git a/gtk/deprecated/gtkhbox.c b/gtk/deprecated/gtkhbox.c
index 0ebd000..3ea3253 100644
--- a/gtk/deprecated/gtkhbox.c
+++ b/gtk/deprecated/gtkhbox.c
@@ -49,7 +49,7 @@
  * very quick and easyÂchange. If you have derived your own classes from
  * GtkHBox, you can simply change the inheritance to derive directly
  * from #GtkBox. No further changes are needed, since the default
- * value of the #GtkOrientable::orientation property is
+ * value of the #GtkOrientable:orientation property is
  * %GTK_ORIENTATION_HORIZONTAL.
  * If you want your code to be future-proof, the recommendation is to
  * switch to #GtkGrid, since #GtkBox is going to be deprecated in favor
diff --git a/gtk/deprecated/gtkvbox.c b/gtk/deprecated/gtkvbox.c
index a74b53f..9105a8c 100644
--- a/gtk/deprecated/gtkvbox.c
+++ b/gtk/deprecated/gtkvbox.c
@@ -49,7 +49,7 @@
  * GtkVBox has been deprecated. You can use #GtkBox instead, which is a
  * very quick and easyÂchange. If you have derived your own classes from
  * GtkVBox, you can simply change the inheritance to derive directly
- * from #GtkBox, and set the #GtkOrientable::orientation property to
+ * from #GtkBox, and set the #GtkOrientable:orientation property to
  * %GTK_ORIENTATION_VERTICAL in your instance init function, with a
  * call like:
  * |[
diff --git a/gtk/gtkactivatable.c b/gtk/gtkactivatable.c
index c22690c..9f659e0 100644
--- a/gtk/gtkactivatable.c
+++ b/gtk/gtkactivatable.c
@@ -340,9 +340,9 @@ gtk_activatable_update (GtkActivatable *activatable,
  * @action: (allow-none): the related #GtkAction or %NULL
  *
  * This is called to update the activatable completely, this is called
- * internally when the #GtkActivatable::related-action property is set
+ * internally when the #GtkActivatable:related-action property is set
  * or unset and by the implementing class when
- * #GtkActivatable::use-action-appearance changes.
+ * #GtkActivatable:use-action-appearance changes.
  *
  * Since: 2.16
  **/
diff --git a/gtk/gtkactivatable.h b/gtk/gtkactivatable.h
index 920b4a4..d713806 100644
--- a/gtk/gtkactivatable.h
+++ b/gtk/gtkactivatable.h
@@ -45,8 +45,8 @@ typedef struct _GtkActivatableIface GtkActivatableIface;
  * You must check the #GtkActivatable:use-action-appearance property only apply action
  * properties that are meant to effect the appearance accordingly.
  * @sync_action_properties: Called to update the activatable completely, this is called internally when
- * #GtkActivatable::related-action property is set or unset and by the implementor when
- * #GtkActivatable::use-action-appearance changes.<note><para>This method can be called
+ * #GtkActivatable:related-action property is set or unset and by the implementor when
+ * #GtkActivatable:use-action-appearance changes.<note><para>This method can be called
  * with a %NULL action at times</para></note>
  *
  * Since: 2.16
diff --git a/gtk/gtkappchooserbutton.c b/gtk/gtkappchooserbutton.c
index bd1d335..b49cf99 100644
--- a/gtk/gtkappchooserbutton.c
+++ b/gtk/gtkappchooserbutton.c
@@ -31,14 +31,14 @@
  *
  * Initially, a #GtkAppChooserButton selects the first application
  * in its list, which will either be the most-recently used application
- * or, if #GtkAppChooserButton::show-default-item is %TRUE, the
+ * or, if #GtkAppChooserButton:show-default-item is %TRUE, the
  * default application.
  *
  * The list of applications shown in a #GtkAppChooserButton includes
  * the recommended applications for the given content type. When
- * #GtkAppChooserButton::show-default-item is set, the default application
+ * #GtkAppChooserButton:show-default-item is set, the default application
  * is also included. To let the user chooser other applications,
- * you can set the #GtkAppChooserButton::show-dialog-item property,
+ * you can set the #GtkAppChooserButton:show-dialog-item property,
  * which allows to open a full #GtkAppChooserDialog.
  *
  * It is possible to add custom items to the list, using
diff --git a/gtk/gtkbbox.c b/gtk/gtkbbox.c
index bdecd58..69bab41 100644
--- a/gtk/gtkbbox.c
+++ b/gtk/gtkbbox.c
@@ -42,10 +42,10 @@
  * same size. GtkButtonBox gives all children the same size, but it does allow
  * 'outliers' to keep their own larger size. To force all children to be
  * strictly the same size without exceptions, you can set the
- * #GtkButtonBox::homogeneous property to %TRUE.
+ * #GtkButtonBox:homogeneous property to %TRUE.
  *
  * To excempt individual children from homogeneous sizing regardless of their
- * 'outlier' status, you can set the #GtkButtonBox::non-homogeneous child
+ * 'outlier' status, you can set the #GtkButtonBox:non-homogeneous child
  * property.
  */
 
diff --git a/gtk/gtkcomboboxtext.c b/gtk/gtkcomboboxtext.c
index f077c8e..81bbd19 100644
--- a/gtk/gtkcomboboxtext.c
+++ b/gtk/gtkcomboboxtext.c
@@ -467,7 +467,7 @@ gtk_combo_box_text_prepend (GtkComboBoxText *combo_box,
  *
  * Inserts @text at @position in the list of strings stored in @combo_box.
  * If @id is non-%NULL then it is used as the ID of the row.  See
- * #GtkComboBox::id-column.
+ * #GtkComboBox:id-column.
  *
  * If @position is negative then @text is appended.
  *
diff --git a/gtk/gtkentry.c b/gtk/gtkentry.c
index 552dfd6..d201aff 100644
--- a/gtk/gtkentry.c
+++ b/gtk/gtkentry.c
@@ -1392,7 +1392,7 @@ gtk_entry_class_init (GtkEntryClass *class)
    *
    * The invisible character is used when masking entry contents (in
    * \"password mode\")"). When it is not explicitly set with the
-   * #GtkEntry::invisible-char property, GTK+ determines the character
+   * #GtkEntry:invisible-char property, GTK+ determines the character
    * to use from a list of possible candidates, depending on availability
    * in the current font.
    *
diff --git a/gtk/gtkiconview.c b/gtk/gtkiconview.c
index 57c2b1d..49ac4a1 100644
--- a/gtk/gtkiconview.c
+++ b/gtk/gtkiconview.c
@@ -4494,7 +4494,7 @@ gtk_icon_view_set_tooltip_query_cb (GtkWidget  *widget,
  * for you. @column should be set to the column in @icon_view's model
  * containing the tooltip texts, or -1 to disable this feature.
  *
- * When enabled, #GtkWidget::has-tooltip will be set to %TRUE and
+ * When enabled, #GtkWidget:has-tooltip will be set to %TRUE and
  * @icon_view will connect a #GtkWidget::query-tooltip signal handler.
  *
  * Note that the signal handler sets the text with gtk_tooltip_set_markup(),
diff --git a/gtk/gtkoverlay.c b/gtk/gtkoverlay.c
index b116ecb..6f9cd34 100644
--- a/gtk/gtkoverlay.c
+++ b/gtk/gtkoverlay.c
@@ -37,8 +37,8 @@
  *
  * GtkOverlay is a container which contains a single main child, on top
  * of which it can place <firstterm>overlay</firstterm> widgets. The
- * position of each overlay widget is determined by its #GtkWidget::halign
- * and #GtkWidget::valign properties. E.g. a widget with both alignments
+ * position of each overlay widget is determined by its #GtkWidget:halign
+ * and #GtkWidget:valign properties. E.g. a widget with both alignments
  * set to %GTK_ALIGN_START will be placed at the top left corner of the
  * main widget, whereas an overlay with halign set to %GTK_ALIGN_CENTER
  * and valign set to %GTK_ALIGN_END will be placed a the bottom edge of
@@ -605,7 +605,7 @@ gtk_overlay_new (void)
  * added with gtk_container_add().
  *
  * The position at which @widget is placed is determined
- * from its #GtkWidget::halign and #GtkWidget::valign properties.
+ * from its #GtkWidget:halign and #GtkWidget:valign properties.
  *
  * Since: 3.2
  */
diff --git a/gtk/gtkprintoperation.c b/gtk/gtkprintoperation.c
index 87f4d4e..6150a11 100644
--- a/gtk/gtkprintoperation.c
+++ b/gtk/gtkprintoperation.c
@@ -2420,7 +2420,7 @@ gtk_print_operation_set_embed_page_setup (GtkPrintOperation  *op,
  * gtk_print_operation_get_embed_page_setup:
  * @op: a #GtkPrintOperation
  *
- * Gets the value of #GtkPrintOperation::embed-page-setup property.
+ * Gets the value of #GtkPrintOperation:embed-page-setup property.
  * 
  * Returns: whether page setup selection combos are embedded
  *
@@ -3305,7 +3305,7 @@ gtk_print_operation_set_support_selection (GtkPrintOperation  *op,
  * gtk_print_operation_get_support_selection:
  * @op: a #GtkPrintOperation
  *
- * Gets the value of #GtkPrintOperation::support-selection property.
+ * Gets the value of #GtkPrintOperation:support-selection property.
  * 
  * Returns: whether the application supports print of selection
  *
@@ -3354,7 +3354,7 @@ gtk_print_operation_set_has_selection (GtkPrintOperation  *op,
  * gtk_print_operation_get_has_selection:
  * @op: a #GtkPrintOperation
  *
- * Gets the value of #GtkPrintOperation::has-selection property.
+ * Gets the value of #GtkPrintOperation:has-selection property.
  * 
  * Returns: whether there is a selection
  *
diff --git a/gtk/gtkprintunixdialog.c b/gtk/gtkprintunixdialog.c
index 44b0fdc..3c5320f 100644
--- a/gtk/gtkprintunixdialog.c
+++ b/gtk/gtkprintunixdialog.c
@@ -4272,7 +4272,7 @@ gtk_print_unix_dialog_set_manual_capabilities (GtkPrintUnixDialog   *dialog,
  * gtk_print_unix_dialog_get_manual_capabilities:
  * @dialog: a #GtkPrintUnixDialog
  *
- * Gets the value of #GtkPrintUnixDialog::manual-capabilities property.
+ * Gets the value of #GtkPrintUnixDialog:manual-capabilities property.
  *
  * Returns: the printing capabilities
  *
@@ -4332,7 +4332,7 @@ gtk_print_unix_dialog_set_support_selection (GtkPrintUnixDialog *dialog,
  * gtk_print_unix_dialog_get_support_selection:
  * @dialog: a #GtkPrintUnixDialog
  *
- * Gets the value of #GtkPrintUnixDialog::support-selection property.
+ * Gets the value of #GtkPrintUnixDialog:support-selection property.
  *
  * Returns: whether the application supports print of selection
  *
@@ -4386,7 +4386,7 @@ gtk_print_unix_dialog_set_has_selection (GtkPrintUnixDialog *dialog,
  * gtk_print_unix_dialog_get_has_selection:
  * @dialog: a #GtkPrintUnixDialog
  *
- * Gets the value of #GtkPrintUnixDialog::has-selection property.
+ * Gets the value of #GtkPrintUnixDialog:has-selection property.
  *
  * Returns: whether there is a selection
  *
@@ -4454,7 +4454,7 @@ gtk_print_unix_dialog_set_embed_page_setup (GtkPrintUnixDialog *dialog,
  * gtk_print_unix_dialog_get_embed_page_setup:
  * @dialog: a #GtkPrintUnixDialog
  *
- * Gets the value of #GtkPrintUnixDialog::embed-page-setup property.
+ * Gets the value of #GtkPrintUnixDialog:embed-page-setup property.
  *
  * Returns: whether there is a selection
  *
diff --git a/gtk/gtktoolitem.c b/gtk/gtktoolitem.c
index 213fc82..dd1b60e 100644
--- a/gtk/gtktoolitem.c
+++ b/gtk/gtktoolitem.c
@@ -788,7 +788,7 @@ gtk_tool_item_get_orientation (GtkToolItem *tool_item)
  * show text</listitem>
  * <listitem> GTK_TOOLBAR_BOTH_HORIZ, meaning the tool item should show
  * both an icon and a label, arranged horizontally (however, note the 
- * #GtkToolButton::has_text_horizontally that makes tool buttons not
+ * #GtkToolButton:has_text_horizontally property that makes tool buttons not
  * show labels when the toolbar style is GTK_TOOLBAR_BOTH_HORIZ.
  * </listitem>
  * </itemizedlist>
diff --git a/gtk/gtkwidget.c b/gtk/gtkwidget.c
index 0e4d198..96dd94e 100644
--- a/gtk/gtkwidget.c
+++ b/gtk/gtkwidget.c
@@ -1494,7 +1494,7 @@ gtk_widget_class_init (GtkWidgetClass *klass)
    * The ::state-changed signal is emitted when the widget state changes.
    * See gtk_widget_get_state().
    *
-   * Deprecated: 3.0. Use #GtkWidget::state-flags-changed instead.
+   * Deprecated: 3.0. Use #GtkWidget:state-flags-changed instead.
    */
   widget_signals[STATE_CHANGED] =
     g_signal_new (I_("state-changed"),
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]