glib r7078 - in trunk: . docs/reference/gobject gobject

[stefkost svn gnome org]

Author: stefkost
Date: Sat Jun 21 17:25:17 2008
New Revision: 7078
URL: http://svn.gnome.org/viewvc/glib?rev=7078&view=rev

Log:
	* 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.



Modified:
   trunk/ChangeLog
   trunk/docs/reference/gobject/Makefile.am
   trunk/gobject/gboxed.h
   trunk/gobject/gclosure.c
   trunk/gobject/gparam.c
   trunk/gobject/gparam.h
   trunk/gobject/gtype.h

Modified: trunk/docs/reference/gobject/Makefile.am
==============================================================================
--- trunk/docs/reference/gobject/Makefile.am	(original)
+++ trunk/docs/reference/gobject/Makefile.am	Sat Jun 21 17:25:17 2008
@@ -33,7 +33,7 @@
 	$(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 		\

Modified: trunk/gobject/gboxed.h
==============================================================================
--- trunk/gobject/gboxed.h	(original)
+++ trunk/gobject/gboxed.h	Sat Jun 21 17:25:17 2008
@@ -124,7 +124,7 @@
  * 
  * 
  * gchar *writers[];
- * g_object_get (obj, "authors", &writers, NULL);
+ * g_object_get (obj, "authors", &writers, NULL);
  * // do something with writers
  * g_strfreev (writers);
  * ]|

Modified: trunk/gobject/gclosure.c
==============================================================================
--- trunk/gobject/gclosure.c	(original)
+++ trunk/gobject/gclosure.c	Sat Jun 21 17:25:17 2008
@@ -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 <link linkend="glib-genmarshal"
- * >glib-genmarshal</link> utility.
+ * C marshallers can be generated with the
+ * <link linkend="glib-genmarshal">glib-genmarshal</link> 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_*() 

Modified: trunk/gobject/gparam.c
==============================================================================
--- trunk/gobject/gparam.c	(original)
+++ trunk/gobject/gparam.c	Sat Jun 21 17:25:17 2008
@@ -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.
+ * </para>
  */
 /*
  * MT safe

Modified: trunk/gobject/gparam.h
==============================================================================
--- trunk/gobject/gparam.h	(original)
+++ trunk/gobject/gparam.h	Sat Jun 21 17:25:17 2008
@@ -185,8 +185,8 @@
  * @value_type: the #GValue type for this parameter
  * @owner_type: #GType type that uses (introduces) this paremeter
  * 
- * All fields of the <structname>GParamSpec</structname> struct are private and
- * should not be used directly, except for the following:
+ * All other fields of the <structname>GParamSpec</structname> struct are private and
+ * should not be used directly.
  */
 struct _GParamSpec
 {

Modified: trunk/gobject/gtype.h
==============================================================================
--- trunk/gobject/gtype.h	(original)
+++ trunk/gobject/gtype.h	Sat Jun 21 17:25:17 2008
@@ -700,7 +700,7 @@
  * of a specific type. This function should initialize all static class
  * members.
  * The initialization process of a class involves:
- * <variablelist>
+ * <itemizedlist>
  * <listitem><para>
  * 	1 - Copying common members from the parent class over to the
  * 	derived class structure.
@@ -716,7 +716,7 @@
  * <listitem><para>
  * 	4 - Invocation of the class' GClassInitFunc() initializer.
  * </para></listitem>
- * </variablelist>
+ * </itemizedlist>
  * 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 @@
 /**
  * GTypeValueTable:
  * @value_init: Default initialize @values contents by poking values
- *  directly into the value-&gt;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 <function>memset()</function>, so no care has to
  *  be taken to free any
@@ -1001,7 +1001,7 @@
  *  value that may never be %NULL, the implementation might
  *  look like:
  *  |[
- *  value-&gt;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 @@
  *  this function returns. E.g. for our above string type:
  *  |[
  *  // only free strings without a specific flag for static storage
- *  if (!(value-&gt;data[1].v_uint &amp; G_VALUE_NOCOPY_CONTENTS))
- *    g_free (value-&gt;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 @@
  *  @src_value has been freed, the contents of @dest_value
  *  remain valid. String type example:
  *  |[
- *  dest_value-&gt;data[0].v_pointer = g_strdup (src_value-&gt;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-&gt;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:
  *  <variablelist>
- *  <varlistentry><term></term><listitem><para>
+ *  <varlistentry><term /><listitem><para>
  *  'i' - Integers. passed as collect_values[].v_int.
  *  </para></listitem></varlistentry>
- *  <varlistentry><term></term><listitem><para>
+ *  <varlistentry><term /><listitem><para>
  *  'l' - Longs. passed as collect_values[].v_long.
  *  </para></listitem></varlistentry>
- *  <varlistentry><term></term><listitem><para>
+ *  <varlistentry><term /><listitem><para>
  *  'd' - Doubles. passed as collect_values[].v_double.
  *  </para></listitem></varlistentry>
- *  <varlistentry><term></term><listitem><para>
+ *  <varlistentry><term /><listitem><para>
  *  'p' - Pointers. passed as collect_values[].v_pointer.
  *  </para></listitem></varlistentry>
  *  </variablelist>
@@ -1064,7 +1064,7 @@
  *  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 @@
  *  |[
  *  if (!collect_values[0].v_pointer)
  *    value->data[0].v_pointer = g_strdup ("");
- *  else if (collect_flags &amp; G_VALUE_NOCOPY_CONTENTS)
+ *  else if (collect_flags & G_VALUE_NOCOPY_CONTENTS)
  *  {
- *    value-&gt;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-&gt;data[1].v_uint = G_VALUE_NOCOPY_CONTENTS;
+ *    value->data[1].v_uint = G_VALUE_NOCOPY_CONTENTS;
  *  }
  *  else
- *    value-&gt;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-&gt;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 @@
  *  {
  *    GObject *object = G_OBJECT (collect_values[0].v_pointer);
  *    // never honour G_VALUE_NOCOPY_CONTENTS for ref-counted types
- *    value-&gt;data[0].v_pointer = g_object_ref (object);
+ *    value->data[0].v_pointer = g_object_ref (object);
  *    return NULL;
  *  }
  *  else
@@ -1124,9 +1124,9 @@
  *  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 @@
  *  gchar **string_p = collect_values[0].v_pointer;
  *  if (!string_p)
  *    return g_strdup_printf ("string location passed as NULL");
- *  if (collect_flags &amp; G_VALUE_NOCOPY_CONTENTS)
- *    *string_p = value-&gt;data[0].v_pointer;
+ *  if (collect_flags & G_VALUE_NOCOPY_CONTENTS)
+ *    *string_p = value->data[0].v_pointer;
  *  else
- *    *string_p = g_strdup (value-&gt;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 @@
  *  GObject **object_p = collect_values[0].v_pointer;
  *  if (!object_p)
  *    return g_strdup_printf ("object location passed as NULL");
- *  if (!value-&gt;data[0].v_pointer)
+ *  if (!value->data[0].v_pointer)
  *    *object_p = NULL;
- *  else if (collect_flags &amp; G_VALUE_NOCOPY_CONTENTS) // always honour
- *    *object_p = value-&gt;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-&gt;data[0].v_pointer);
+ *    *object_p = g_object_ref (value->data[0].v_pointer);
  *  return NULL;
  *  ]|
  * 
@@ -1323,12 +1323,12 @@
  *         0,      // n_preallocs 
  *         (GInstanceInitFunc) gtk_gadget_init, 
  *       }; 
- *       g_define_type_id = g_type_register_static (GTK_TYPE_WIDGET, "GtkGadget", &amp;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, &amp;g_implement_interface_info);
+ *         g_type_add_interface_static (g_define_type_id, TYPE_GIZMO, &g_implement_interface_info);
  *       } 
  *     } 
  *   return g_define_type_id;