[glib] Docs: don't use structfield tags
- From: Matthias Clasen <matthiasc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glib] Docs: don't use structfield tags
- Date: Fri, 31 Jan 2014 05:00:46 +0000 (UTC)
commit 6f3c465535311a028c12cc04d4188ce79eb03560
Author: Matthias Clasen <mclasen redhat com>
Date: Thu Jan 30 23:59:06 2014 -0500
Docs: don't use structfield tags
They don't add anything over @foo, and we want to avoid explicit
docbook markup as far as possible.
glib/docs.c | 4 ++--
gobject/gtype.c | 6 ++----
2 files changed, 4 insertions(+), 6 deletions(-)
---
diff --git a/glib/docs.c b/glib/docs.c
index 6b4d7d6..6ca8c48 100644
--- a/glib/docs.c
+++ b/glib/docs.c
@@ -1678,8 +1678,8 @@
/**
* G_STRUCT_OFFSET:
- * @struct_type: a structure type, e.g. <structname>GtkWidget</structname>
- * @member: a field in the structure, e.g. <structfield>window</structfield>
+ * @struct_type: a structure type, e.g. #GtkWidget
+ * @member: a field in the structure, e.g. @window
*
* Returns the offset, in bytes, of a member of a struct.
*
diff --git a/gobject/gtype.c b/gobject/gtype.c
index 6b1cf7d..098e816 100644
--- a/gobject/gtype.c
+++ b/gobject/gtype.c
@@ -3178,8 +3178,7 @@ g_type_interface_peek_parent (gpointer g_iface)
* If the type is not currently in use, then the default vtable
* for the type will be created and initalized by calling
* the base interface init and default vtable init functions for
- * the type (the @<structfield>base_init</structfield>
- * and <structfield>class_init</structfield> members of #GTypeInfo).
+ * the type (the @base_init and @class_init members of #GTypeInfo).
* Calling g_type_default_interface_ref() is useful when you
* want to make sure that signals and properties for an interface
* have been installed.
@@ -3265,8 +3264,7 @@ g_type_default_interface_peek (GType g_type)
* interface default vtable @g_iface. If the type is dynamic, then
* when no one is using the interface and all references have
* been released, the finalize function for the interface's default
- * vtable (the <structfield>class_finalize</structfield> member of
- * #GTypeInfo) will be called.
+ * vtable (the @class_finalize member of #GTypeInfo) will be called.
*
* Since: 2.4
*/
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]