[gtk+] docs: don't use structfield tags
- From: William Jon McCann <mccann src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk+] docs: don't use structfield tags
- Date: Tue, 28 Jan 2014 01:14:14 +0000 (UTC)
commit 4872ee75e6cb2a2067c71983fe68d7e3309cd1b6
Author: William Jon McCann <william jon mccann gmail com>
Date: Mon Jan 27 17:13:43 2014 -0500
docs: don't use structfield tags
gdk/gdkcolor.c | 3 +--
gdk/gdkrgba.c | 4 +---
gtk/gtkbox.c | 3 +--
gtk/gtkdialog.c | 2 +-
gtk/gtktreemodel.h | 4 ++--
5 files changed, 6 insertions(+), 10 deletions(-)
---
diff --git a/gdk/gdkcolor.c b/gdk/gdkcolor.c
index 34e1e20..e2371c9 100644
--- a/gdk/gdkcolor.c
+++ b/gdk/gdkcolor.c
@@ -128,8 +128,7 @@ G_DEFINE_BOXED_TYPE (GdkColor, gdk_color,
* @color: (out): the #GdkColor to fill in
*
* Parses a textual specification of a color and fill in the
- * <structfield>red</structfield>, <structfield>green</structfield>,
- * and <structfield>blue</structfield> fields of a #GdkColor.
+ * @red, @green, and @blue fields of a #GdkColor.
*
* The string can either one of a large set of standard names
* (taken from the X11 <filename>rgb.txt</filename> file), or
diff --git a/gdk/gdkrgba.c b/gdk/gdkrgba.c
index e524106..254abf3 100644
--- a/gdk/gdkrgba.c
+++ b/gdk/gdkrgba.c
@@ -138,9 +138,7 @@ parse_rgb_value (const gchar *str,
* @spec: the string specifying the color
*
* Parses a textual representation of a color, filling in
- * the <structfield>red</structfield>, <structfield>green</structfield>,
- * <structfield>blue</structfield> and <structfield>alpha</structfield>
- * fields of the @rgba #GdkRGBA.
+ * the @red, @green, @blue and @alpha fields of the @rgba #GdkRGBA.
*
* The string can be either one of:
* <itemizedlist>
diff --git a/gtk/gtkbox.c b/gtk/gtkbox.c
index 916079a..4ec256f 100644
--- a/gtk/gtkbox.c
+++ b/gtk/gtkbox.c
@@ -1833,8 +1833,7 @@ _gtk_box_get_spacing_set (GtkBox *box)
* the list
*
* Moves @child to a new @position in the list of @box children.
- * The list is the <structfield>children</structfield> field of
- * #GtkBox-struct, and contains both widgets packed #GTK_PACK_START
+ * The list contains widgets packed #GTK_PACK_START
* as well as widgets packed #GTK_PACK_END, in the order that these
* widgets were added to @box.
*
diff --git a/gtk/gtkdialog.c b/gtk/gtkdialog.c
index 49babdb..5bc5b3a 100644
--- a/gtk/gtkdialog.c
+++ b/gtk/gtkdialog.c
@@ -57,7 +57,7 @@
* GTK+ treats a dialog as a window split vertically. The top section is a
* #GtkVBox, and is where widgets such as a #GtkLabel or a #GtkEntry should
* be packed. The bottom area is known as the
- * <structfield>action_area</structfield>. This is generally used for
+ * <quote>action_area</quote>. This is generally used for
* packing buttons into the dialog which may perform functions such as
* cancel, ok, or apply.
*
diff --git a/gtk/gtktreemodel.h b/gtk/gtktreemodel.h
index 6cb64e1..d702b3b 100644
--- a/gtk/gtktreemodel.h
+++ b/gtk/gtktreemodel.h
@@ -86,8 +86,8 @@ typedef enum
*
* The #GtkTreeIter is the primary structure
* for accessing a #GtkTreeModel. Models are expected to put a unique
- * integer in the <structfield>stamp</structfield> member, and put
- * model-specific data in the three <structfield>user_data</structfield>
+ * integer in the @stamp member, and put
+ * model-specific data in the three @user_data
* members.
*/
struct _GtkTreeIter
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]