GNOME.org
 

[gtk+] docs: use () instead of <function> tags

commit bf35c77f14f443670bd48bb8a321e974b0e57c7d
Author: William Jon McCann <william jon mccann gmail com>
Date:   Mon Jan 27 23:08:08 2014 -0500

    docs: use () instead of <function> tags

 gdk/gdkevents.h           |   56 +++++++++++++++-----------------------------
 gdk/x11/gdkproperty-x11.c |    2 +-
 gtk/gtkbuildable.c        |    3 +-
 gtk/gtkbuilder.c          |    4 +-
 gtk/gtkclipboard.c        |    2 +-
 gtk/gtkcontainer.c        |    2 +-
 gtk/gtkfilechooser.c      |    3 +-
 gtk/gtkmain.c             |    2 +-
 gtk/gtktreemodel.c        |    2 +-
 9 files changed, 28 insertions(+), 48 deletions(-)
---
diff --git a/gdk/gdkevents.h b/gdk/gdkevents.h
index f808f4d..3dc7b41 100644
--- a/gdk/gdkevents.h
+++ b/gdk/gdkevents.h
@@ -512,8 +512,7 @@ typedef enum
  * GdkEventAny:
  * @type: the type of the event.
  * @window: the window which received the event.
- * @send_event: %TRUE if the event was sent explicitly (e.g. using
- *   <function>XSendEvent</function>).
+ * @send_event: %TRUE if the event was sent explicitly.
  *
  * Contains the fields which are common to all event structs.
  * Any event pointer can safely be cast to a pointer to a #GdkEventAny to
@@ -530,8 +529,7 @@ struct _GdkEventAny
  * GdkEventExpose:
  * @type: the type of the event (%GDK_EXPOSE or %GDK_DAMAGE).
  * @window: the window which received the event.
- * @send_event: %TRUE if the event was sent explicitly (e.g. using
- *   <function>XSendEvent</function>).
+ * @send_event: %TRUE if the event was sent explicitly.
  * @area: bounding box of @region.
  * @region: the region that needs to be redrawn.
  * @count: the number of contiguous %GDK_EXPOSE events following this one.
@@ -556,8 +554,7 @@ struct _GdkEventExpose
  * GdkEventVisibility:
  * @type: the type of the event (%GDK_VISIBILITY_NOTIFY).
  * @window: the window which received the event.
- * @send_event: %TRUE if the event was sent explicitly (e.g. using
- *   <function>XSendEvent</function>).
+ * @send_event: %TRUE if the event was sent explicitly.
  * @state: the new visibility state (%GDK_VISIBILITY_FULLY_OBSCURED,
  *   %GDK_VISIBILITY_PARTIAL or %GDK_VISIBILITY_UNOBSCURED).
  *
@@ -575,8 +572,7 @@ struct _GdkEventVisibility
  * GdkEventMotion:
  * @type: the type of the event.
  * @window: the window which received the event.
- * @send_event: %TRUE if the event was sent explicitly (e.g. using
- *   <function>XSendEvent</function>).
+ * @send_event: %TRUE if the event was sent explicitly.
  * @time: the time of the event in milliseconds.
  * @x: the x coordinate of the pointer relative to the window.
  * @y: the y coordinate of the pointer relative to the window.
@@ -616,8 +612,7 @@ struct _GdkEventMotion
  * @type: the type of the event (%GDK_BUTTON_PRESS, %GDK_2BUTTON_PRESS,
  *   %GDK_3BUTTON_PRESS or %GDK_BUTTON_RELEASE).
  * @window: the window which received the event.
- * @send_event: %TRUE if the event was sent explicitly (e.g. using
- *   <function>XSendEvent</function>).
+ * @send_event: %TRUE if the event was sent explicitly.
  * @time: the time of the event in milliseconds.
  * @x: the x coordinate of the pointer relative to the window.
  * @y: the y coordinate of the pointer relative to the window.
@@ -692,8 +687,7 @@ struct _GdkEventButton
  * @type: the type of the event (%GDK_TOUCH_BEGIN, %GDK_TOUCH_UPDATE,
  *   %GDK_TOUCH_END, %GDK_TOUCH_CANCEL)
  * @window: the window which received the event
- * @send_event: %TRUE if the event was sent explicitly (e.g. using
- *   <function>XSendEvent</function>)
+ * @send_event: %TRUE if the event was sent explicitly.
  * @time: the time of the event in milliseconds.
  * @x: the x coordinate of the pointer relative to the window
  * @y: the y coordinate of the pointer relative to the window
@@ -743,8 +737,7 @@ struct _GdkEventTouch
  * GdkEventScroll:
  * @type: the type of the event (%GDK_SCROLL).
  * @window: the window which received the event.
- * @send_event: %TRUE if the event was sent explicitly (e.g. using
- *   <function>XSendEvent</function>).
+ * @send_event: %TRUE if the event was sent explicitly.
  * @time: the time of the event in milliseconds.
  * @x: the x coordinate of the pointer relative to the window.
  * @y: the y coordinate of the pointer relative to the window.
@@ -792,8 +785,7 @@ struct _GdkEventScroll
  * GdkEventKey:
  * @type: the type of the event (%GDK_KEY_PRESS or %GDK_KEY_RELEASE).
  * @window: the window which received the event.
- * @send_event: %TRUE if the event was sent explicitly (e.g. using
- *   <function>XSendEvent</function>).
+ * @send_event: %TRUE if the event was sent explicitly.
  * @time: the time of the event in milliseconds.
  * @state: (type GdkModifierType): a bit-mask representing the state of
  *   the modifier keys (e.g. Control, Shift and Alt) and the pointer
@@ -839,8 +831,7 @@ struct _GdkEventKey
  * GdkEventCrossing:
  * @type: the type of the event (%GDK_ENTER_NOTIFY or %GDK_LEAVE_NOTIFY).
  * @window: the window which received the event.
- * @send_event: %TRUE if the event was sent explicitly (e.g. using
- *  <function>XSendEvent</function>).
+ * @send_event: %TRUE if the event was sent explicitly.
  * @subwindow: the window that was entered or left.
  * @time: the time of the event in milliseconds.
  * @x: the x coordinate of the pointer relative to the window.
@@ -883,8 +874,7 @@ struct _GdkEventCrossing
  * GdkEventFocus:
  * @type: the type of the event (%GDK_FOCUS_CHANGE).
  * @window: the window which received the event.
- * @send_event: %TRUE if the event was sent explicitly (e.g. using
- *   <function>XSendEvent</function>).
+ * @send_event: %TRUE if the event was sent explicitly.
  * @in: %TRUE if the window has gained the keyboard focus, %FALSE if
  *   it has lost the focus.
  *
@@ -902,8 +892,7 @@ struct _GdkEventFocus
  * GdkEventConfigure:
  * @type: the type of the event (%GDK_CONFIGURE).
  * @window: the window which received the event.
- * @send_event: %TRUE if the event was sent explicitly (e.g. using
- *   <function>XSendEvent</function>).
+ * @send_event: %TRUE if the event was sent explicitly.
  * @x: the new x coordinate of the window, relative to its parent.
  * @y: the new y coordinate of the window, relative to its parent.
  * @width: the new width of the window.
@@ -925,8 +914,7 @@ struct _GdkEventConfigure
  * GdkEventProperty:
  * @type: the type of the event (%GDK_PROPERTY_NOTIFY).
  * @window: the window which received the event.
- * @send_event: %TRUE if the event was sent explicitly (e.g. using
- *   <function>XSendEvent</function>).
+ * @send_event: %TRUE if the event was sent explicitly.
  * @atom: the property that was changed.
  * @time: the time of the event in milliseconds.
  * @state: (type GdkPropertyState): whether the property was changed
@@ -949,8 +937,7 @@ struct _GdkEventProperty
  * @type: the type of the event (%GDK_SELECTION_CLEAR,
  *   %GDK_SELECTION_NOTIFY or %GDK_SELECTION_REQUEST).
  * @window: the window which received the event.
- * @send_event: %TRUE if the event was sent explicitly (e.g. using
- *   <function>XSendEvent</function>).
+ * @send_event: %TRUE if the event was sent explicitly.
  * @selection: the selection.
  * @target: the target to which the selection should be converted.
  * @property: the property in which to place the result of the conversion.
@@ -976,8 +963,7 @@ struct _GdkEventSelection
  * GdkEventOwnerChange:
  * @type: the type of the event (%GDK_OWNER_CHANGE).
  * @window: the window which received the event
- * @send_event: %TRUE if the event was sent explicitly (e.g. using
- *   <function>XSendEvent</function>)
+ * @send_event: %TRUE if the event was sent explicitly.
  * @owner: the new owner of the selection, or %NULL if there is none
  * @reason: the reason for the ownership change as a #GdkOwnerChange value
  * @selection: the atom identifying the selection
@@ -1007,7 +993,7 @@ struct _GdkEventOwnerChange
  * GdkEventProximity:
  * @type: the type of the event (%GDK_PROXIMITY_IN or %GDK_PROXIMITY_OUT).
  * @window: the window which received the event.
- * @send_event: %TRUE if the event was sent explicitly (e.g. using <function>XSendEvent</function>).
+ * @send_event: %TRUE if the event was sent explicitly.
  * @time: the time of the event in milliseconds.
  * @device: the master device that the event originated from. Use
  * gdk_event_get_source_device() to get the slave device.
@@ -1035,8 +1021,7 @@ struct _GdkEventProximity
  * GdkEventSetting:
  * @type: the type of the event (%GDK_SETTING).
  * @window: the window which received the event.
- * @send_event: %TRUE if the event was sent explicitly (e.g. using
- *   <function>XSendEvent</function>).
+ * @send_event: %TRUE if the event was sent explicitly.
  * @action: what happened to the setting (%GDK_SETTING_ACTION_NEW,
  *   %GDK_SETTING_ACTION_CHANGED or %GDK_SETTING_ACTION_DELETED).
  * @name: the name of the setting.
@@ -1056,8 +1041,7 @@ struct _GdkEventSetting
  * GdkEventWindowState:
  * @type: the type of the event (%GDK_WINDOW_STATE).
  * @window: the window which received the event.
- * @send_event: %TRUE if the event was sent explicitly (e.g. using
- *   <function>XSendEvent</function>).
+ * @send_event: %TRUE if the event was sent explicitly.
  * @changed_mask: mask specifying what flags have changed.
  * @new_window_state: the new window state, a combination of
  *   #GdkWindowState bits.
@@ -1078,8 +1062,7 @@ struct _GdkEventWindowState
  * @type: the type of the event (%GDK_GRAB_BROKEN)
  * @window: the window which received the event, i.e. the window
  *   that previously owned the grab
- * @send_event: %TRUE if the event was sent explicitly (e.g. using
- *   <function>XSendEvent</function>).
+ * @send_event: %TRUE if the event was sent explicitly.
  * @keyboard: %TRUE if a keyboard grab was broken, %FALSE if a pointer
  *   grab was broken
  * @implicit: %TRUE if the broken grab was implicit
@@ -1110,8 +1093,7 @@ struct _GdkEventGrabBroken {
  *   %GDK_DRAG_MOTION, %GDK_DRAG_STATUS, %GDK_DROP_START or
  *   %GDK_DROP_FINISHED).
  * @window: the window which received the event.
- * @send_event: %TRUE if the event was sent explicitly (e.g. using
- *   <function>XSendEvent</function>).
+ * @send_event: %TRUE if the event was sent explicitly.
  * @context: the #GdkDragContext for the current DND operation.
  * @time: the time of the event in milliseconds.
  * @x_root: the x coordinate of the pointer relative to the root of the
diff --git a/gdk/x11/gdkproperty-x11.c b/gdk/x11/gdkproperty-x11.c
index 4deb90f..70d29ef 100644
--- a/gdk/x11/gdkproperty-x11.c
+++ b/gdk/x11/gdkproperty-x11.c
@@ -426,7 +426,7 @@ gdk_x11_get_xatom_name_for_display (GdkDisplay *display,
  * 
  * Returns the name of an X atom for GDK's default display. This
  * function is meant mainly for debugging, so for convenience, unlike
- * <function>XAtomName()</function> and gdk_atom_name(), the result 
+ * XAtomName() and gdk_atom_name(), the result 
  * doesn't need to be freed. Also, this function will never return %NULL, 
  * even if @xatom is invalid.
  * 
diff --git a/gtk/gtkbuildable.c b/gtk/gtkbuildable.c
index 3264e05..e23829e 100644
--- a/gtk/gtkbuildable.c
+++ b/gtk/gtkbuildable.c
@@ -29,8 +29,7 @@
  * The GtkBuildable interface is implemented by all widgets and
  * many of the non-widget objects that are provided by GTK+. The
  * main user of this interface is #GtkBuilder. There should be
- * very little need for applications to call any
- * <function>gtk_buildable_...</function> functions.
+ * very little need for applications to call any of these functions directly.
  *
  * <note><para>An object only needs to implement this interface if it needs
  * to extend the #GtkBuilder format or run any extra routines at deserialization time</para></note>
diff --git a/gtk/gtkbuilder.c b/gtk/gtkbuilder.c
index 01ae50d..81b8413 100644
--- a/gtk/gtkbuilder.c
+++ b/gtk/gtkbuilder.c
@@ -91,10 +91,10 @@
  *
  * Typically, the specific kind of object represented by an &lt;object&gt;
  * element is specified by the "class" attribute. If the type has not been
- * loaded yet, GTK+ tries to find the <function>_get_type(<!-- -->)</function> from the
+ * loaded yet, GTK+ tries to find the _get_type(<!-- -->) from the
  * class name by applying heuristics. This works in most cases, but if
  * necessary, it is possible to specify the name of the
- * <function>_get_type(<!-- -->)</function> explictly with the "type-func" attribute.
+ * _get_type(<!-- -->) explictly with the "type-func" attribute.
  * As a special case, GtkBuilder allows to use an object that has been
  * constructed by a #GtkUIManager in another part of the UI definition by
  * specifying the id of the #GtkUIManager in the "constructor" attribute and the
diff --git a/gtk/gtkclipboard.c b/gtk/gtkclipboard.c
index 62baf6b..69d13c8 100644
--- a/gtk/gtkclipboard.c
+++ b/gtk/gtkclipboard.c
@@ -821,7 +821,7 @@ text_clear_func (GtkClipboard *clipboard,
  * @clipboard: a #GtkClipboard object
  * @text:      a UTF-8 string.
  * @len:       length of @text, in bytes, or -1, in which case
- *             the length will be determined with <function>strlen()</function>.
+ *             the length will be determined with strlen().
  * 
  * Sets the contents of the clipboard to the given UTF-8 string. GTK+ will
  * make a copy of the text and take responsibility for responding
diff --git a/gtk/gtkcontainer.c b/gtk/gtkcontainer.c
index dfa2a17..7f7e41e 100644
--- a/gtk/gtkcontainer.c
+++ b/gtk/gtkcontainer.c
@@ -151,7 +151,7 @@
  *
  * Height for width requests are generally implemented in terms of a virtual allocation
  * of widgets in the input orientation. Assuming an height-for-width request mode, a container
- * would implement the <function>get_preferred_height_for_width(<!-- -->)</function> virtual function by 
first calling
+ * would implement the get_preferred_height_for_width(<!-- -->) virtual function by first calling
  * gtk_widget_get_preferred_width() for each of its children.
  *
  * For each potential group of children that are lined up horizontally, the values returned by
diff --git a/gtk/gtkfilechooser.c b/gtk/gtkfilechooser.c
index 0bee123..1b05cd0 100644
--- a/gtk/gtkfilechooser.c
+++ b/gtk/gtkfilechooser.c
@@ -83,8 +83,7 @@
  * <note>
  *    This means that while you can pass the result of
  *    gtk_file_chooser_get_filename() to
- *    <function>open(2)</function> or
- *    <function>fopen(3)</function>, you may not be able to
+ *    open(2) or fopen(3), you may not be able to
  *    directly set it as the text of a #GtkLabel widget unless you
  *    convert it first to UTF-8, which all GTK+ widgets expect.
  *    You should use g_filename_to_utf8() to convert filenames
diff --git a/gtk/gtkmain.c b/gtk/gtkmain.c
index c1b08cf..1f1e6bf 100644
--- a/gtk/gtkmain.c
+++ b/gtk/gtkmain.c
@@ -54,7 +54,7 @@
  * main loop and await more user input.
  * </para>
  * <example>
- * <title>Typical <function>main()</function> function for a GTK+ application</title>
+ * <title>Typical main() function for a GTK+ application</title>
  * <programlisting>
  * int
  * main (int argc, char **argv)
diff --git a/gtk/gtktreemodel.c b/gtk/gtktreemodel.c
index 58b000f..dfc1503 100644
--- a/gtk/gtktreemodel.c
+++ b/gtk/gtktreemodel.c
@@ -141,7 +141,7 @@
  *
  * This second example shows a quick way of iterating through a list
  * and getting a string and an integer from each row. The
- * <function>populate_model</function> function used below is not
+ * populate_model() function used below is not
  * shown, as it is specific to the #GtkListStore. For information on
  * how to write such a function, see the #GtkListStore documentation.
  *
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]