summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorWilliam Jon McCann <william.jon.mccann@gmail.com>2014-02-04 23:57:30 -0500
committerWilliam Jon McCann <william.jon.mccann@gmail.com>2014-02-06 08:01:49 -0500
commit6abe7a7094e019581e048a88c01b6e563aec03e1 (patch)
tree3046673211ef89217dfdfc7b51eb08b021324efb
parent8dcda824d2e2583b59571c5688fc55cd76d5d38f (diff)
downloadgtk+-6abe7a7094e019581e048a88c01b6e563aec03e1.tar.gz
docs: use markdown instead of <note>
-rw-r--r--gdk/gdkevents.h8
-rw-r--r--gdk/x11/gdkdevicemanager-x11.c12
-rw-r--r--gtk/deprecated/gtkactivatable.c34
-rw-r--r--gtk/deprecated/gtkactivatable.h5
-rw-r--r--gtk/deprecated/gtkhandlebox.c8
-rw-r--r--gtk/deprecated/gtkhseparator.c10
-rw-r--r--gtk/deprecated/gtkstyle.c40
-rw-r--r--gtk/deprecated/gtktable.c8
-rw-r--r--gtk/deprecated/gtktearoffmenuitem.c4
-rw-r--r--gtk/deprecated/gtkuimanager.c8
-rw-r--r--gtk/gtkmessagedialog.h9
11 files changed, 64 insertions, 82 deletions
diff --git a/gdk/gdkevents.h b/gdk/gdkevents.h
index e5eb17ecf2..458e550bc6 100644
--- a/gdk/gdkevents.h
+++ b/gdk/gdkevents.h
@@ -45,12 +45,8 @@ G_BEGIN_DECLS
*
* The event structures contain data specific to each type of event in GDK.
*
- * <note>
- * <para>
- * A common mistake is to forget to set the event mask of a widget so that
- * the required events are received. See gtk_widget_set_events().
- * </para>
- * </note>
+ * > A common mistake is to forget to set the event mask of a widget so that
+ * > the required events are received. See gtk_widget_set_events().
*/
diff --git a/gdk/x11/gdkdevicemanager-x11.c b/gdk/x11/gdkdevicemanager-x11.c
index 61a958930b..0dae46d083 100644
--- a/gdk/x11/gdkdevicemanager-x11.c
+++ b/gdk/x11/gdkdevicemanager-x11.c
@@ -124,13 +124,11 @@ gdk_x11_device_manager_lookup (GdkDeviceManager *device_manager,
*
* Returns the device ID as seen by XInput2.
*
- * <note>
- * If gdk_disable_multidevice() has been called, this function
- * will respectively return 2/3 for the core pointer and keyboard,
- * (matching the IDs for the Virtual Core Pointer and Keyboard in
- * XInput 2), but calling this function on any slave devices (i.e.
- * those managed via XInput 1.x), will return 0.
- * </note>
+ * > If gdk_disable_multidevice() has been called, this function
+ * > will respectively return 2/3 for the core pointer and keyboard,
+ * > (matching the IDs for the Virtual Core Pointer and Keyboard in
+ * > XInput 2), but calling this function on any slave devices (i.e.
+ * > those managed via XInput 1.x), will return 0.
*
* Returns: the XInput2 device ID.
*
diff --git a/gtk/deprecated/gtkactivatable.c b/gtk/deprecated/gtkactivatable.c
index f9916019e5..3d36e391fd 100644
--- a/gtk/deprecated/gtkactivatable.c
+++ b/gtk/deprecated/gtkactivatable.c
@@ -274,12 +274,12 @@ gtk_activatable_default_init (GtkActivatableInterface *iface)
{
/**
* GtkActivatable:related-action:
- *
+ *
* The action that this activatable will activate and receive
* updates from for various states and possibly appearance.
*
- * <note><para>#GtkActivatable implementors need to handle the this property and
- * call gtk_activatable_do_set_related_action() when it changes.</para></note>
+ * > #GtkActivatable implementors need to handle the this property and
+ * > call gtk_activatable_do_set_related_action() when it changes.
*
* Since: 2.16
*
@@ -294,7 +294,7 @@ gtk_activatable_default_init (GtkActivatableInterface *iface)
/**
* GtkActivatable:use-action-appearance:
- *
+ *
* Whether this activatable should reset its layout
* and appearance when setting the related action or when
* the action changes appearance.
@@ -302,9 +302,9 @@ gtk_activatable_default_init (GtkActivatableInterface *iface)
* See the #GtkAction documentation directly to find which properties
* should be ignored by the #GtkActivatable when this property is %FALSE.
*
- * <note><para>#GtkActivatable implementors need to handle this property
- * and call gtk_activatable_sync_action_properties() on the activatable
- * widget when it changes.</para></note>
+ * > #GtkActivatable implementors need to handle this property
+ * > and call gtk_activatable_sync_action_properties() on the activatable
+ * > widget when it changes.
*
* Since: 2.16
*
@@ -375,8 +375,8 @@ gtk_activatable_sync_action_properties (GtkActivatable *activatable,
*
* Sets the related action on the @activatable object.
*
- * <note><para>#GtkActivatable implementors need to handle the #GtkActivatable:related-action
- * property and call gtk_activatable_do_set_related_action() when it changes.</para></note>
+ * > #GtkActivatable implementors need to handle the #GtkActivatable:related-action
+ * > property and call gtk_activatable_do_set_related_action() when it changes.
*
* Since: 2.16
*
@@ -416,10 +416,10 @@ gtk_activatable_action_notify (GtkAction *action,
* method is called when the related #GtkAction properties change
* and registers to the action's proxy list.
*
- * <note><para>Be careful to call this before setting the local
- * copy of the #GtkAction property, since this function uses
- * gtk_activatable_get_related_action() to retrieve the
- * previous action</para></note>
+ * > Be careful to call this before setting the local
+ * > copy of the #GtkAction property, since this function uses
+ * > gtk_activatable_get_related_action() to retrieve the
+ * > previous action.
*
* Since: 2.16
*
@@ -517,10 +517,10 @@ gtk_activatable_get_related_action (GtkActivatable *activatable)
* Sets whether this activatable should reset its layout and appearance
* when setting the related action or when the action changes appearance
*
- * <note><para>#GtkActivatable implementors need to handle the
- * #GtkActivatable:use-action-appearance property and call
- * gtk_activatable_sync_action_properties() to update @activatable
- * if needed.</para></note>
+ * > #GtkActivatable implementors need to handle the
+ * > #GtkActivatable:use-action-appearance property and call
+ * > gtk_activatable_sync_action_properties() to update @activatable
+ * > if needed.
*
* Since: 2.16
*
diff --git a/gtk/deprecated/gtkactivatable.h b/gtk/deprecated/gtkactivatable.h
index 2fa825ad73..dd89d85b72 100644
--- a/gtk/deprecated/gtkactivatable.h
+++ b/gtk/deprecated/gtkactivatable.h
@@ -44,8 +44,9 @@ typedef struct _GtkActivatableIface GtkActivatableIface;
* 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
- * with a %NULL action at times</para></note>
+ * #GtkActivatable:use-action-appearance changes.
+ *
+ * > This method can be called with a %NULL action at times.
*
* Since: 2.16
*
diff --git a/gtk/deprecated/gtkhandlebox.c b/gtk/deprecated/gtkhandlebox.c
index 30b20486ed..36a788301c 100644
--- a/gtk/deprecated/gtkhandlebox.c
+++ b/gtk/deprecated/gtkhandlebox.c
@@ -66,11 +66,9 @@
* allocation will remain fixed as the height of the handlebox shrinks,
* so the snap edge should be set to %GTK_POS_BOTTOM.
*
- * <note>
- * #GtkHandleBox has been deprecated. It is very specialized, lacks features
- * to make it useful and most importantly does not fit well into modern
- * application design. Do not use it. There is no replacement.
- * </note>
+ * > #GtkHandleBox has been deprecated. It is very specialized, lacks features
+ * > to make it useful and most importantly does not fit well into modern
+ * > application design. Do not use it. There is no replacement.
*/
diff --git a/gtk/deprecated/gtkhseparator.c b/gtk/deprecated/gtkhseparator.c
index 3a6c42dc52..02fa37d7ab 100644
--- a/gtk/deprecated/gtkhseparator.c
+++ b/gtk/deprecated/gtkhseparator.c
@@ -39,12 +39,10 @@ G_GNUC_BEGIN_IGNORE_DEPRECATIONS
* widgets within a window. It displays a horizontal line with a shadow to
* make it appear sunken into the interface.
*
- * <note>
- * The #GtkHSeparator widget is not used as a separator within menus.
- * To create a separator in a menu create an empty #GtkSeparatorMenuItem
- * widget using gtk_separator_menu_item_new() and add it to the menu with
- * gtk_menu_shell_append().
- * </note>
+ * > The #GtkHSeparator widget is not used as a separator within menus.
+ * > To create a separator in a menu create an empty #GtkSeparatorMenuItem
+ * > widget using gtk_separator_menu_item_new() and add it to the menu with
+ * > gtk_menu_shell_append().
*
* GtkHSeparator has been deprecated, use #GtkSeparator instead.
*/
diff --git a/gtk/deprecated/gtkstyle.c b/gtk/deprecated/gtkstyle.c
index 0bfd9f49e3..fb6f1d57fa 100644
--- a/gtk/deprecated/gtkstyle.c
+++ b/gtk/deprecated/gtkstyle.c
@@ -4375,17 +4375,15 @@ gtk_widget_modify_fg (GtkWidget *widget,
* All other style values are left untouched.
* See also gtk_widget_modify_style().
*
- * <note><para>
- * Note that “no window” widgets (which have the %GTK_NO_WINDOW
- * flag set) draw on their parent container's window and thus may
- * not draw any background themselves. This is the case for e.g.
- * #GtkLabel.
- * </para><para>
- * To modify the background of such widgets, you have to set the
- * background color on their parent; if you want to set the background
- * of a rectangular area around a label, try placing the label in
- * a #GtkEventBox widget and setting the background color on that.
- * </para></note>
+ * > Note that “no window” widgets (which have the %GTK_NO_WINDOW
+ * > flag set) draw on their parent container's window and thus may
+ * > not draw any background themselves. This is the case for e.g.
+ * > #GtkLabel.
+ * >
+ * > To modify the background of such widgets, you have to set the
+ * > background color on their parent; if you want to set the background
+ * > of a rectangular area around a label, try placing the label in
+ * > a #GtkEventBox widget and setting the background color on that.
*
* Deprecated:3.0: Use gtk_widget_override_background_color() instead
*/
@@ -4475,17 +4473,15 @@ gtk_widget_modify_text (GtkWidget *widget,
* (see gtk_widget_modify_text()) for widgets such as #GtkEntry
* and #GtkTextView. See also gtk_widget_modify_style().
*
- * <note><para>
- * Note that “no window” widgets (which have the %GTK_NO_WINDOW
- * flag set) draw on their parent container's window and thus may
- * not draw any background themselves. This is the case for e.g.
- * #GtkLabel.
- * </para><para>
- * To modify the background of such widgets, you have to set the
- * base color on their parent; if you want to set the background
- * of a rectangular area around a label, try placing the label in
- * a #GtkEventBox widget and setting the base color on that.
- * </para></note>
+ * > Note that “no window” widgets (which have the %GTK_NO_WINDOW
+ * > flag set) draw on their parent container's window and thus may
+ * > not draw any background themselves. This is the case for e.g.
+ * > #GtkLabel.
+ * >
+ * > To modify the background of such widgets, you have to set the
+ * > base color on their parent; if you want to set the background
+ * > of a rectangular area around a label, try placing the label in
+ * > a #GtkEventBox widget and setting the base color on that.
*
* Deprecated:3.0: Use gtk_widget_override_background_color() instead
*/
diff --git a/gtk/deprecated/gtktable.c b/gtk/deprecated/gtktable.c
index bfdef2fd27..c006e87ff2 100644
--- a/gtk/deprecated/gtktable.c
+++ b/gtk/deprecated/gtktable.c
@@ -60,11 +60,9 @@
* gtk_table_set_homogeneous(), can be used to set whether all cells in the
* table will resize themselves to the size of the largest widget in the table.
*
- * <note>
- * #GtkTable has been deprecated. Use #GtkGrid instead. It provides the same
- * capabilities as GtkTable for arranging widgets in a rectangular grid, but
- * does support height-for-width geometry management.
- * </note>
+ * > #GtkTable has been deprecated. Use #GtkGrid instead. It provides the same
+ * > capabilities as GtkTable for arranging widgets in a rectangular grid, but
+ * > does support height-for-width geometry management.
*/
diff --git a/gtk/deprecated/gtktearoffmenuitem.c b/gtk/deprecated/gtktearoffmenuitem.c
index c15102b077..c850d665f1 100644
--- a/gtk/deprecated/gtktearoffmenuitem.c
+++ b/gtk/deprecated/gtktearoffmenuitem.c
@@ -51,8 +51,8 @@ G_GNUC_BEGIN_IGNORE_DEPRECATIONS
* the tearoff menu can be reattached. Activating it will erase the tearoff
* menu window.
*
- * <note>#GtkTearoffMenuItem is deprecated and should not be used in newly
- * written code. Menus are not meant to be torn around.</note>
+ * > #GtkTearoffMenuItem is deprecated and should not be used in newly
+ * > written code. Menus are not meant to be torn around.
*/
diff --git a/gtk/deprecated/gtkuimanager.c b/gtk/deprecated/gtkuimanager.c
index 109aab5745..955068c41d 100644
--- a/gtk/deprecated/gtkuimanager.c
+++ b/gtk/deprecated/gtkuimanager.c
@@ -65,11 +65,9 @@
* The UI definitions are specified in an XML format which can be
* roughly described by the following DTD.
*
- * <note><para>
- * Do not confuse the GtkUIManager UI Definitions described here with
- * the similarly named <link linkend="BUILDER-UI">GtkBuilder UI
- * Definitions</link>.
- * </para></note>
+ * > Do not confuse the GtkUIManager UI Definitions described here with
+ * > the similarly named <link linkend="BUILDER-UI">GtkBuilder UI
+ * > Definitions</link>.
*
* |[
* <!ELEMENT ui (menubar|toolbar|popup|accelerator)* >
diff --git a/gtk/gtkmessagedialog.h b/gtk/gtkmessagedialog.h
index 973e39c0d0..ef082c11f5 100644
--- a/gtk/gtkmessagedialog.h
+++ b/gtk/gtkmessagedialog.h
@@ -77,11 +77,10 @@ struct _GtkMessageDialogClass
* Prebuilt sets of buttons for the dialog. If
* none of these choices are appropriate, simply use %GTK_BUTTONS_NONE
* then call gtk_dialog_add_buttons().
- * <note>
- * Please note that %GTK_BUTTONS_OK, %GTK_BUTTONS_YES_NO
- * and %GTK_BUTTONS_OK_CANCEL are discouraged by the
- * [GNOME Human Interface Guidelines](http://library.gnome.org/devel/hig-book/stable/).
- * </note>
+ *
+ * > Please note that %GTK_BUTTONS_OK, %GTK_BUTTONS_YES_NO
+ * > and %GTK_BUTTONS_OK_CANCEL are discouraged by the
+ * > [GNOME Human Interface Guidelines](http://library.gnome.org/devel/hig-book/stable/).
*/
typedef enum
{