GNOME.org
 

[glib] GObject docs: resolve broken links

commit 9829d04be86fde5741340ed20b5bc0ae876c95e9
Author: Ryan Lortie <desrt desrt ca>
Date:   Mon Sep 5 18:46:59 2011 -0400

    GObject docs: resolve broken links
    
    Some links were broken due to typos, because functionality was removed
    in GLib 2.0 or for various other reasons.  Fix up as many of them as is
    reasonable.

 docs/reference/gobject/tut_gobject.xml |    8 +++-----
 docs/reference/gobject/tut_gsignal.xml |    7 ++++---
 docs/reference/gobject/tut_gtype.xml   |    2 +-
 docs/reference/gobject/tut_howto.xml   |    4 ++--
 gobject/gobject.c                      |    4 ++--
 gobject/gparam.h                       |    4 ++--
 gobject/gparamspecs.c                  |    2 +-
 gobject/gsignal.h                      |    4 ++--
 gobject/gtype.c                        |    6 +++---
 gobject/gtype.h                        |    9 +++++----
 gobject/gvalue.h                       |    2 +-
 gobject/gvaluecollector.h              |    1 -
 12 files changed, 26 insertions(+), 27 deletions(-)
---
diff --git a/docs/reference/gobject/tut_gobject.xml b/docs/reference/gobject/tut_gobject.xml
index edeb6ea..f5fe43a 100644
--- a/docs/reference/gobject/tut_gobject.xml
+++ b/docs/reference/gobject/tut_gobject.xml
@@ -619,8 +619,7 @@ g_value_unset (&amp;val);
   
     <para>
       <function><link linkend="g-object-set-property">g_object_set_property</link></function> first ensures a property
-      with this name was registered in bar's class_init handler. If so, it calls
-      <function><link linkend="object-set-property">object_set_property</link></function> which first walks the class hierarchy,
+      with this name was registered in bar's class_init handler. If so it walks the class hierarchy,
       from bottom, most derived type, to top, fundamental type to find the class
       which registered that property. It then tries to convert the user-provided GValue
       into a GValue whose type is that of the associated property.
@@ -662,7 +661,7 @@ g_value_unset (&amp;val);
       <footnote>
         <para>
           It should be noted that the param_id used here need only to uniquely identify each 
-          <link linkend="GParamSpec"><type>GParamSpec</type></link> within the <link linkend="FooClass"><type>FooClass</type></link> such that the switch
+          <link linkend="GParamSpec"><type>GParamSpec</type></link> within the <type>FooClass</type> such that the switch
           used in the set and get methods actually works. Of course, this locally-unique 
           integer is purely an optimization: it would have been possible to use a set of 
           <emphasis>if (strcmp (a, b) == 0) {} else if (strcmp (a, b) == 0) {}</emphasis> statements.
@@ -674,8 +673,7 @@ g_value_unset (&amp;val);
   
     <para>
       Once the property has been set by the object's set_property class method, the code path
-      returns to <function><link linkend="g-object-set-property">g_object_set_property</link></function> which calls 
-      <function><link linkend="g-object-notify-queue-thaw">g_object_notify_queue_thaw</link></function>. This function makes sure that
+      returns to <function><link linkend="g-object-set-property">g_object_set_property</link></function> which makes sure that
       the "notify" signal is emitted on the object's instance with the changed property as
       parameter unless notifications were frozen by <function><link linkend="g-object-freeze-notify">g_object_freeze_notify</link></function>.
     </para>
diff --git a/docs/reference/gobject/tut_gsignal.xml b/docs/reference/gobject/tut_gsignal.xml
index 87f6c75..7d0cf3f 100644
--- a/docs/reference/gobject/tut_gsignal.xml
+++ b/docs/reference/gobject/tut_gsignal.xml
@@ -396,9 +396,10 @@ void g_signal_emitv (const GValue *instance_and_params,
 	  </para>
   
 	  <para>
-		If, at any point during emission (except in RUN_CLEANUP state), one of the 
-		closures or emission hook stops the signal emission with 
-		<function><link linkend="g-signal-stop">g_signal_stop</link></function>, emission jumps to CLEANUP state.
+		If, at any point during emission (except in RUN_CLEANUP state), one of the
+		closures or emission hook stops the signal emission with
+		<function><link linkend="g-signal-stop-emission">g_signal_stop_emission</link></function>,
+		emission jumps to CLEANUP state.
 	  </para>
   
 	  <para>
diff --git a/docs/reference/gobject/tut_gtype.xml b/docs/reference/gobject/tut_gtype.xml
index 2128aca..f040366 100644
--- a/docs/reference/gobject/tut_gtype.xml
+++ b/docs/reference/gobject/tut_gtype.xml
@@ -564,7 +564,7 @@ void           g_type_free_instance   (GTypeInstance *instance);
             referred to as finalization in GType) is the symmetric process of 
             the initialization: interfaces are destroyed first. 
             Then, the most derived 
-            class_finalize (<link linkend="ClassFinalizeFunc"><type>ClassFinalizeFunc</type></link>) function is invoked. The 
+            class_finalize (<link linkend="GClassFinalizeFunc"><type>GClassFinalizeFunc</type></link>) function is invoked. The 
             base_class_finalize (<link linkend="GBaseFinalizeFunc"><type>GBaseFinalizeFunc</type></link>) functions are 
             Finally invoked from bottom-most most-derived type to top-most fundamental type and 
             the class structure is freed.
diff --git a/docs/reference/gobject/tut_howto.xml b/docs/reference/gobject/tut_howto.xml
index 2cfcea6..1534838 100644
--- a/docs/reference/gobject/tut_howto.xml
+++ b/docs/reference/gobject/tut_howto.xml
@@ -825,8 +825,8 @@ void maman_ibaz_do_action (MamanIbaz *self);
     <itemizedlist>
       <listitem><para>
         The <function>_GET_CLASS</function> macro is called <function>_GET_INTERFACE</function>
-                  and not implemented with <function><link linkend="G_TYPE_INSTANCE_GET_CLASS">G_TYPE_INSTANCE_GET_CLASS</link></function>
-                  but with <function><link linkend="G_TYPE_INSTANCE_GET_INTERFACE">G_TYPE_INSTANCE_GET_INTERFACE</link></function>.
+                  and not implemented with <function><link linkend="G-TYPE-INSTANCE-GET-CLASS:CAPS">G_TYPE_INSTANCE_GET_CLASS</link></function>
+                  but with <function><link linkend="G-TYPE-INSTANCE-GET-INTERFACE:CAPS">G_TYPE_INSTANCE_GET_INTERFACE</link></function>.
       </para></listitem>
       <listitem><para>
         The instance type, <type>MamanIbaz</type> is not fully defined: it is
diff --git a/gobject/gobject.c b/gobject/gobject.c
index 3488380..c2bdbf7 100644
--- a/gobject/gobject.c
+++ b/gobject/gobject.c
@@ -2525,7 +2525,7 @@ toggle_refs_notify (GObject *object,
  * true) or weak to strong (@is_last_ref false).
  *
  * Since a (normal) reference must be held to the object before
- * calling g_object_toggle_ref(), the initial state of the reverse
+ * calling g_object_add_toggle_ref(), the initial state of the reverse
  * link is always strong.
  *
  * Multiple toggle references may be added to the same gobject,
@@ -3242,7 +3242,7 @@ g_value_dup_object (const GValue *value)
  * @detailed_signal: a string of the form "signal-name::detail".
  * @c_handler: the #GCallback to connect.
  * @gobject: the object to pass as data to @c_handler.
- * @connect_flags: a combination of #GConnnectFlags.
+ * @connect_flags: a combination of #GConnectFlags.
  *
  * This is similar to g_signal_connect_data(), but uses a closure which
  * ensures that the @gobject stays alive during the call to @c_handler
diff --git a/gobject/gparam.h b/gobject/gparam.h
index 07855ee..c9a991b 100644
--- a/gobject/gparam.h
+++ b/gobject/gparam.h
@@ -228,7 +228,7 @@ struct _GParamSpec
  *  g_param_value_set_default().
  * @value_validate: Ensures that the contents of @value comply with the 
  *  specifications set out by this type (optional), see 
- *  g_param_value_set_validate().
+ *  g_param_value_validate().
  * @values_cmp: Compares @value1 with @value2 according to this type
  *  (recommended, the default is memcmp()), see g_param_values_cmp().
  * 
@@ -331,7 +331,7 @@ typedef struct _GParamSpecTypeInfo GParamSpecTypeInfo;
  *  g_param_value_set_default().
  * @value_validate: Ensures that the contents of @value comply with the 
  *  specifications set out by @pspec (optional), see 
- *  g_param_value_set_validate().
+ *  g_param_value_validate().
  * @values_cmp: Compares @value1 with @value2 according to @pspec 
  *  (recommended, the default is memcmp()), see g_param_values_cmp().
  * 
diff --git a/gobject/gparamspecs.c b/gobject/gparamspecs.c
index d1e3e88..86d5699 100644
--- a/gobject/gparamspecs.c
+++ b/gobject/gparamspecs.c
@@ -2287,7 +2287,7 @@ g_param_spec_boxed (const gchar *name,
  * @blurb: description of the property specified
  * @flags: flags for the property specified
  *
- * Creates a new #GParamSpecPoiner instance specifying a pointer property.
+ * Creates a new #GParamSpecPointer instance specifying a pointer property.
  *
  * See g_param_spec_internal() for details on property names.
  *
diff --git a/gobject/gsignal.h b/gobject/gsignal.h
index 6c70d53..0fae33e 100644
--- a/gobject/gsignal.h
+++ b/gobject/gsignal.h
@@ -230,8 +230,8 @@ struct _GSignalInvocationHint
  *  effective callback signature is:
  *  <programlisting>
  *  @return_type callback (#gpointer     data1,
- *  [#param_types param_names,]
- *  #gpointer     data2);
+ *  [param_types param_names,]
+ *  gpointer     data2);
  *  </programlisting>
  * 
  * A structure holding in-depth information for a specific signal. It is
diff --git a/gobject/gtype.c b/gobject/gtype.c
index 096a8c5..44fc39d 100644
--- a/gobject/gtype.c
+++ b/gobject/gtype.c
@@ -2787,9 +2787,9 @@ g_type_register_dynamic (GType        parent_type,
  * @info: The #GInterfaceInfo structure for this
  *        (@instance_type, @interface_type) combination.
  *
- * Adds the static @interface_type to @instantiable_type.  The information
- * contained in the #GTypeInterfaceInfo structure pointed to by @info
- * is used to manage the relationship.
+ * Adds the static @interface_type to @instantiable_type.  The
+ * information contained in the #GInterfaceInfo structure pointed to by
+ * @info is used to manage the relationship.
  */
 void
 g_type_add_interface_static (GType                 instance_type,
diff --git a/gobject/gtype.h b/gobject/gtype.h
index 89548e9..7d1e8ff 100644
--- a/gobject/gtype.h
+++ b/gobject/gtype.h
@@ -1125,10 +1125,11 @@ struct _GInterfaceInfo
  *  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.
- *  To deviate from our string example for a moment, and taking a look
- *  at an exemplary implementation for collect_value() of #GObject:
+ *  by the signal emission code, reference counts should always be
+ *  incremented 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:
  *  |[
  *  if (collect_values[0].v_pointer)
  *  {
diff --git a/gobject/gvalue.h b/gobject/gvalue.h
index e1f6980..5708682 100644
--- a/gobject/gvalue.h
+++ b/gobject/gvalue.h
@@ -157,7 +157,7 @@ void	g_value_register_transform_func	(GType		 src_type,
  *
  * If passed to G_VALUE_COLLECT(), allocated data won't be copied
  * but used verbatim. This does not affect ref-counted types like
- * objects. For more details, see the #GValueTable documentation.
+ * objects.
  */
 #define G_VALUE_NOCOPY_CONTENTS (1 << 27)
 
diff --git a/gobject/gvaluecollector.h b/gobject/gvaluecollector.h
index b39b40d..9bdf482 100644
--- a/gobject/gvaluecollector.h
+++ b/gobject/gvaluecollector.h
@@ -21,7 +21,6 @@
 /**
  * SECTION:value_collection
  * @Short_description: Converting varargs to generic values
- * @See_also:#GValueTable
  * @Title: Varargs Value Collection
  * 
  * The macros in this section provide the varargs parsing support needed
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]