From: Stefan Kost Date: Sat, 21 Jun 2008 17:25:17 +0000 (+0000) Subject: Add --sgml-mode to allow sgml in doc-fragments (which somehow works before X-Git-Url: http://git.openbox.org/?a=commitdiff_plain;h=f22d19fc3455d38811e950cf88a2e1c0506c5f7e;p=dana%2Fcg-glib.git Add --sgml-mode to allow sgml in doc-fragments (which somehow works before * docs/reference/gobject/Makefile.am: Add --sgml-mode to allow sgml in doc-fragments (which somehow works before already). * gobject/gboxed.h: * gobject/gclosure.c: * gobject/gparam.c: * gobject/gparam.h: * gobject/gtype.h: Convert character entities back. FIx some broken sgml. svn path=/trunk/; revision=7078 --- diff --git a/ChangeLog b/ChangeLog index 690fcdbb..05b3a333 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,16 @@ +2008-06-21 Stefan Kost + + * docs/reference/gobject/Makefile.am: + Add --sgml-mode to allow sgml in doc-fragments (which somehow works + before already). + + * gobject/gboxed.h: + * gobject/gclosure.c: + * gobject/gparam.c: + * gobject/gparam.h: + * gobject/gtype.h: + Convert character entities back. FIx some broken sgml. + 2008-06-21 Stefan Kost * docs/reference/gobject/tmpl/gtypemodule.sgml: diff --git a/docs/reference/gobject/Makefile.am b/docs/reference/gobject/Makefile.am index 00ee0ea5..f20684f2 100644 --- a/docs/reference/gobject/Makefile.am +++ b/docs/reference/gobject/Makefile.am @@ -33,7 +33,7 @@ GTKDOC_LIBS = \ $(top_builddir)/gobject/libgobject-2.0.la # Extra options to supply to gtkdoc-mkdb -MKDB_OPTIONS= +MKDB_OPTIONS=--sgml-mode # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE) content_files = version.xml \ diff --git a/gobject/gboxed.h b/gobject/gboxed.h index 32de0249..7d778c08 100644 --- a/gobject/gboxed.h +++ b/gobject/gboxed.h @@ -124,7 +124,7 @@ GType g_boxed_type_register_static (const gchar *name, * * * gchar *writers[]; - * g_object_get (obj, "authors", &writers, NULL); + * g_object_get (obj, "authors", &writers, NULL); * // do something with writers * g_strfreev (writers); * ]| diff --git a/gobject/gclosure.c b/gobject/gclosure.c index 64a31abc..b1ca90e8 100644 --- a/gobject/gclosure.c +++ b/gobject/gclosure.c @@ -41,8 +41,8 @@ * g_signal_new() specifies the default C marshaller for any closure which is * connected to this signal. GObject provides a number of C marshallers * for this purpose, see the g_cclosure_marshal_*() functions. Additional - * C marshallers can be generated with the glib-genmarshal utility. + * C marshallers can be generated with the + * glib-genmarshal utility. * Closures can be explicitly connected to signals with * g_signal_connect_closure(), but it usually more convenient to let GObject * create a closure automatically by using one of the g_signal_connect_*() diff --git a/gobject/gparam.c b/gobject/gparam.c index 544f431d..e1f7f783 100644 --- a/gobject/gparam.c +++ b/gobject/gparam.c @@ -32,6 +32,7 @@ * All other characters are replaced by a '-' during construction. * The result of this replacement is called the canonical name of the * parameter. + * */ /* * MT safe diff --git a/gobject/gparam.h b/gobject/gparam.h index c2a370c0..41091d50 100644 --- a/gobject/gparam.h +++ b/gobject/gparam.h @@ -185,8 +185,8 @@ typedef struct _GParamSpecPool GParamSpecPool; * @value_type: the #GValue type for this parameter * @owner_type: #GType type that uses (introduces) this paremeter * - * All fields of the GParamSpec struct are private and - * should not be used directly, except for the following: + * All other fields of the GParamSpec struct are private and + * should not be used directly. */ struct _GParamSpec { diff --git a/gobject/gtype.h b/gobject/gtype.h index 565df25c..8ae923a1 100644 --- a/gobject/gtype.h +++ b/gobject/gtype.h @@ -700,7 +700,7 @@ typedef void (*GBaseFinalizeFunc) (gpointer g_class); * of a specific type. This function should initialize all static class * members. * The initialization process of a class involves: - * + * * * 1 - Copying common members from the parent class over to the * derived class structure. @@ -716,7 +716,7 @@ typedef void (*GBaseFinalizeFunc) (gpointer g_class); * * 4 - Invocation of the class' GClassInitFunc() initializer. * - * + * * Since derived classes are partially initialized through a memory copy * of the parent class, the general rule is that GBaseInitFunc() and * GBaseFinalizeFunc() should take care of necessary reinitialization @@ -993,7 +993,7 @@ struct _GInterfaceInfo /** * GTypeValueTable: * @value_init: Default initialize @values contents by poking values - * directly into the value->data array. The data array of + * directly into the value->data array. The data array of * the #GValue passed into this function was zero-filled * with memset(), so no care has to * be taken to free any @@ -1001,7 +1001,7 @@ struct _GInterfaceInfo * value that may never be %NULL, the implementation might * look like: * |[ - * value->data[0].v_pointer = g_strdup (""); + * value->data[0].v_pointer = g_strdup (""); * ]| * @value_free: Free any old contents that might be left in the * data array of the passed in @value. No resources may @@ -1009,8 +1009,8 @@ struct _GInterfaceInfo * this function returns. E.g. for our above string type: * |[ * // only free strings without a specific flag for static storage - * if (!(value->data[1].v_uint & G_VALUE_NOCOPY_CONTENTS)) - * g_free (value->data[0].v_pointer); + * if (!(value->data[1].v_uint & G_VALUE_NOCOPY_CONTENTS)) + * g_free (value->data[0].v_pointer); * ]| * @value_copy: @dest_value is a #GValue with zero-filled data section * and @src_value is a properly setup #GValue of same or @@ -1020,29 +1020,29 @@ struct _GInterfaceInfo * @src_value has been freed, the contents of @dest_value * remain valid. String type example: * |[ - * dest_value->data[0].v_pointer = g_strdup (src_value->data[0].v_pointer); + * dest_value->data[0].v_pointer = g_strdup (src_value->data[0].v_pointer); * ]| * @value_peek_pointer: If the value contents fit into a pointer, such as objects * or strings, return this pointer, so the caller can peek at * the current contents. To extend on our above string example: * |[ - * return value->data[0].v_pointer; + * return value->data[0].v_pointer; * ]| * @collect_format: A string format describing how to collect the contents of * this value bit-by-bit. Each character in the format represents * an argument to be collected, and the characters themselves indicate * the type of the argument. Currently supported arguments are: * - * + * * 'i' - Integers. passed as collect_values[].v_int. * - * + * * 'l' - Longs. passed as collect_values[].v_long. * - * + * * 'd' - Doubles. passed as collect_values[].v_double. * - * + * * 'p' - Pointers. passed as collect_values[].v_pointer. * * @@ -1064,7 +1064,7 @@ struct _GInterfaceInfo * length @n_collect_values, containing the collected values * according to @collect_format. * @collect_flags is an argument provided as a hint by the caller. - * It may contain the flag #G_VALUE_NOCOPY_CONTENTS indicating, + * It may contain the flag %G_VALUE_NOCOPY_CONTENTS indicating, * that the collected value contents may be considered "static" * for the duration of the @value lifetime. * Thus an extra copy of the contents stored in @collect_values is @@ -1073,21 +1073,21 @@ struct _GInterfaceInfo * |[ * if (!collect_values[0].v_pointer) * value->data[0].v_pointer = g_strdup (""); - * else if (collect_flags & G_VALUE_NOCOPY_CONTENTS) + * else if (collect_flags & G_VALUE_NOCOPY_CONTENTS) * { - * value->data[0].v_pointer = collect_values[0].v_pointer; + * value->data[0].v_pointer = collect_values[0].v_pointer; * // keep a flag for the value_free() implementation to not free this string - * value->data[1].v_uint = G_VALUE_NOCOPY_CONTENTS; + * value->data[1].v_uint = G_VALUE_NOCOPY_CONTENTS; * } * else - * value->data[0].v_pointer = g_strdup (collect_values[0].v_pointer); + * value->data[0].v_pointer = g_strdup (collect_values[0].v_pointer); * return NULL; * ]| * It should be noted, that it is generally a bad idea to follow the * #G_VALUE_NOCOPY_CONTENTS hint for reference counted types. Due to * reentrancy requirements and reference count assertions performed * by the #GSignal code, reference counts should always be incremented - * for reference counted contents stored in the value->data array. + * for reference counted contents stored in the value->data array. * To deviate from our string example for a moment, and taking a look * at an exemplary implementation for collect_value() of #GObject: * |[ @@ -1095,7 +1095,7 @@ struct _GInterfaceInfo * { * GObject *object = G_OBJECT (collect_values[0].v_pointer); * // never honour G_VALUE_NOCOPY_CONTENTS for ref-counted types - * value->data[0].v_pointer = g_object_ref (object); + * value->data[0].v_pointer = g_object_ref (object); * return NULL; * } * else @@ -1124,9 +1124,9 @@ struct _GInterfaceInfo * arguments passed through a variable argument list which got * collected into @collect_values according to @lcopy_format. * @n_collect_values equals the string length of @lcopy_format, - * and @collect_flags may contain #G_VALUE_NOCOPY_CONTENTS. + * and @collect_flags may contain %G_VALUE_NOCOPY_CONTENTS. * In contrast to collect_value(), lcopy_value() is obliged to - * always properly support #G_VALUE_NOCOPY_CONTENTS. + * always properly support %G_VALUE_NOCOPY_CONTENTS. * Similar to collect_value() the function may prematurely abort * by returning a newly allocated string describing an error condition. * To complete the string example: @@ -1134,10 +1134,10 @@ struct _GInterfaceInfo * gchar **string_p = collect_values[0].v_pointer; * if (!string_p) * return g_strdup_printf ("string location passed as NULL"); - * if (collect_flags & G_VALUE_NOCOPY_CONTENTS) - * *string_p = value->data[0].v_pointer; + * if (collect_flags & G_VALUE_NOCOPY_CONTENTS) + * *string_p = value->data[0].v_pointer; * else - * *string_p = g_strdup (value->data[0].v_pointer); + * *string_p = g_strdup (value->data[0].v_pointer); * ]| * And an illustrative version of lcopy_value() for * reference-counted types: @@ -1145,12 +1145,12 @@ struct _GInterfaceInfo * GObject **object_p = collect_values[0].v_pointer; * if (!object_p) * return g_strdup_printf ("object location passed as NULL"); - * if (!value->data[0].v_pointer) + * if (!value->data[0].v_pointer) * *object_p = NULL; - * else if (collect_flags & G_VALUE_NOCOPY_CONTENTS) // always honour - * *object_p = value->data[0].v_pointer; + * else if (collect_flags & G_VALUE_NOCOPY_CONTENTS) // always honour + * *object_p = value->data[0].v_pointer; * else - * *object_p = g_object_ref (value->data[0].v_pointer); + * *object_p = g_object_ref (value->data[0].v_pointer); * return NULL; * ]| * @@ -1323,12 +1323,12 @@ gpointer g_type_instance_get_private (GTypeInstance *instance, * 0, // n_preallocs * (GInstanceInitFunc) gtk_gadget_init, * }; - * g_define_type_id = g_type_register_static (GTK_TYPE_WIDGET, "GtkGadget", &g_define_type_info, 0); + * g_define_type_id = g_type_register_static (GTK_TYPE_WIDGET, "GtkGadget", &g_define_type_info, 0); * { * static const GInterfaceInfo g_implement_interface_info = { * (GInterfaceInitFunc) gtk_gadget_gizmo_init * }; - * g_type_add_interface_static (g_define_type_id, TYPE_GIZMO, &g_implement_interface_info); + * g_type_add_interface_static (g_define_type_id, TYPE_GIZMO, &g_implement_interface_info); * } * } * return g_define_type_id;