Move some content for gobject-unused.sgml and cleared empty entries. The

	* docs/reference/gobject/tmpl/gobject-unused.sgml:
	* gobject/gobject.h:
	* gobject/gtype.c:
	* gobject/gtype.h:
	  Move some content for gobject-unused.sgml and cleared empty entries.
	  The remaining 4 ones should be checked by some else. If they are not
	  needed. The file can be removed.

svn path=/trunk/; revision=7087

diff --git a/ChangeLog b/ChangeLog
index 2cae650..ceb74bf 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,15 @@
 2008-06-22  Stefan Kost  <ensonic@users.sf.net>
 
+       * docs/reference/gobject/tmpl/gobject-unused.sgml:
+       * gobject/gobject.h:
+       * gobject/gtype.c:
+       * gobject/gtype.h:
+         Move some content for gobject-unused.sgml and cleared empty entries.
+         The remaining 4 ones should be checked by some else. If they are not
+         needed. The file can be removed.
+
+2008-06-22  Stefan Kost  <ensonic@users.sf.net>
+
        * docs/reference/gobject/tmpl/value_collection.sgml:
        * gobject/gvaluecollector.h:
          Migrating docs.

diff --git a/docs/reference/gobject/tmpl/gobject-unused.sgml b/docs/reference/gobject/tmpl/gobject-unused.sgml
index e10d7c9..48f8a2e 100644 (file)
--- a/docs/reference/gobject/tmpl/gobject-unused.sgml
+++ b/docs/reference/gobject/tmpl/gobject-unused.sgml
@@ -1,43 +1,3 @@
-<!-- ##### SECTION ./tmpl/param_specs.sgml:Long_Description ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/param_specs.sgml:See_Also ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/param_specs.sgml:Short_Description ##### -->
-
-
-
-<!-- ##### SECTION ./tmpl/param_specs.sgml:Title ##### -->
-Parameter Specifications
-
-
-<!-- ##### STRUCT GBoxed ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### USER_FUNCTION GBoxedInitFunc ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
-<!-- ##### STRUCT GParamSpecClosure ##### -->
-<para>
-
-</para>
-
-@parent_instance: 
-
 <!-- ##### ENUM GTypeFundamentals ##### -->
 <para>
 The predefined identifiers of the reserved fundamental types.
@@ -94,172 +54,6 @@ The predefined identifiers of the reserved fundamental types.
 @G_TYPE_PARAM_CLOSURE: 
 @G_TYPE_PARAM_OBJECT: 
 
-<!-- ##### MACRO G_INITIALLY_UNOWNED ##### -->
-<para>
-Casts a #GInitiallyUnowned or derived pointer into a (GInitiallyUnowned*) 
-pointer. Depending on the current debugging level, this function may invoke
-certain runtime checks to identify invalid casts.
-</para>
-
-@object: Object which is subject to casting
-
-<!-- ##### MACRO G_INITIALLY_UNOWNED_CLASS ##### -->
-<para>
-Casts a derived #GInitiallyUnownedClass structure into a 
-#GInitiallyUnownedClass structure.
-</para>
-
-@class: a valid #GInitiallyUnownedClass
-
-<!-- ##### MACRO G_INITIALLY_UNOWNED_GET_CLASS ##### -->
-<para>
-Returns the class structure associated to a #GInitiallyUnowned instance.
-</para>
-
-@object: a #GInitiallyUnowned instance
-
-<!-- ##### MACRO G_IS_INITIALLY_UNOWNED ##### -->
-<para>
-Checks whether a valid #GTypeInstance pointer is of type 
-%G_TYPE_INITIALLY_UNOWNED.
-</para>
-
-@object: Instance to check for being a %G_TYPE_INITIALLY_UNOWNED.
-
-<!-- ##### MACRO G_IS_INITIALLY_UNOWNED_CLASS ##### -->
-<para>
-Checks whether @class "is a" valid #GInitiallyUnownedClass structure of type
-%G_TYPE_INITIALLY_UNOWNED or derived.
-</para>
-
-@class: a #GInitiallyUnownedClass
-
-<!-- ##### MACRO G_IS_PARAM_SPEC_CLOSURE ##### -->
-<para>
-
-</para>
-
-@pspec: 
-
-<!-- ##### MACRO G_PARAM_SPEC_CLOSURE ##### -->
-<para>
-
-</para>
-
-@pspec: 
-
-<!-- ##### MACRO G_TYPE_FUNDAMENTAL_LAST ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO G_TYPE_FUNDAMENTAL_SHIFT ##### -->
-<para>
-Shift value used in converting numbers to type IDs.
-</para>
-
-
-<!-- ##### FUNCTION g_closure_add_fnotify ##### -->
-<para>
-
-</para>
-
-@closure: 
-@notify_data: 
-@notify_func: 
-
-<!-- ##### FUNCTION g_closure_add_inotify ##### -->
-<para>
-
-</para>
-
-@closure: 
-@notify_data: 
-@notify_func: 
-
-<!-- ##### FUNCTION g_closure_remove_fnotify ##### -->
-<para>
-
-</para>
-
-@closure: 
-@notify_data: 
-@notify_func: 
-
-<!-- ##### FUNCTION g_closure_remove_inotify ##### -->
-<para>
-
-</para>
-
-@closure: 
-@notify_data: 
-@notify_func: 
-
-<!-- ##### FUNCTION g_param_spec_closure ##### -->
-<para>
-
-</para>
-
-@name: 
-@nick: 
-@blurb: 
-@flags: 
-@Returns: 
-
-<!-- ##### FUNCTION g_param_spec_string_c ##### -->
-<para>
-
-</para>
-
-@name: 
-@nick: 
-@blurb: 
-@default_value: 
-@flags: 
-@Returns: 
-
-<!-- ##### FUNCTION g_signal_add_emission_hook_full ##### -->
-<para>
-
-</para>
-
-@signal_id: 
-@closure: 
-@Returns: 
-
-<!-- ##### FUNCTION g_signal_handlers_destroy ##### -->
-<para>
-
-</para>
-
-@instance: 
-
-<!-- ##### MACRO g_signal_newc ##### -->
-<para>
-
-</para>
-
-@Returns: 
-@signal_name: 
-@itype: 
-@signal_flags: 
-@class_offset: 
-@accumulator: 
-@accu_data: 
-@c_marshaller: 
-@return_type: 
-@n_params: 
-@Varargs: 
-
-<!-- ##### FUNCTION g_type_check_class_cast ##### -->
-<para>
-</para>
-
-@g_class: 
-@is_a_type: 
-@Returns: 
-
 <!-- ##### FUNCTION g_type_check_flags ##### -->
 <para>
 Determines whether a given set of #GTypeFlags and #GTypeFundamentalFlags
@@ -270,45 +64,6 @@ are set for @type.
 @flags:   Bitwise combination of #GTypeFlags and #GTypeFundamentalFlags.
 @Returns: #TRUE if all @flags are set for @type, #FALSE otherwise.
 
-<!-- ##### FUNCTION g_type_check_instance ##### -->
-<para>
-Private helper function to aid implementation of the G_TYPE_CHECK_INSTANCE()
-macro.
-</para>
-
-@instance: A valid #GTypeInstance structure.
-@Returns:  #TRUE if @instance is valid, #FALSE otherwise.
-
-<!-- ##### FUNCTION g_type_check_instance_cast ##### -->
-<para>
-</para>
-
-@instance: 
-@iface_type: 
-@Returns: 
-
-<!-- ##### FUNCTION g_type_check_value ##### -->
-<para>
-</para>
-
-@value: 
-@Returns: 
-
-<!-- ##### FUNCTION g_type_class_is_a ##### -->
-<para>
-</para>
-
-@g_class: 
-@is_a_type: 
-@Returns: 
-
-<!-- ##### FUNCTION g_type_fundamental_last ##### -->
-<para>
-
-</para>
-
-@Returns: 
-
 <!-- ##### FUNCTION g_type_instance_is_a ##### -->
 <para>
 Determines if @instance adheres to the interface exported
@@ -321,15 +76,6 @@ the anchestry of @instance.
 @iface_type:   A #GType value.
 @Returns:      #TRUE if @instance conforms to @iface_type, #FALSE otherwise.
 
-<!-- ##### FUNCTION g_type_test_flags ##### -->
-<para>
-
-</para>
-
-@type: 
-@flags: 
-@Returns: 
-
 <!-- ##### FUNCTION g_type_value_is_a ##### -->
 <para>
 Determines if @value is a #GValue whose type conforms to @type.
@@ -339,39 +85,3 @@ Determines if @value is a #GValue whose type conforms to @type.
 @type:    A #GType value.
 @Returns: #TRUE if @value is a #GValue of @type or #FALSE if not.
 
-<!-- ##### FUNCTION g_value_convert ##### -->
-<para>
-
-</para>
-
-@src_value: 
-@dest_value: 
-@Returns: 
-
-<!-- ##### FUNCTION g_value_register_exchange_func ##### -->
-<para>
-
-</para>
-
-@value_type1: 
-@value_type2: 
-@func: 
-
-<!-- ##### FUNCTION g_value_types_exchangable ##### -->
-<para>
-
-</para>
-
-@value_type1: 
-@value_type2: 
-@Returns: 
-
-<!-- ##### FUNCTION g_values_exchange ##### -->
-<para>
-
-</para>
-
-@value1: 
-@value2: 
-@Returns: 
-

diff --git a/gobject/gobject.h b/gobject/gobject.h
index 5ef57af..f2653d3 100644 (file)
--- a/gobject/gobject.h
+++ b/gobject/gobject.h
@@ -136,10 +136,46 @@ G_BEGIN_DECLS
  * The type for #GInitiallyUnowned.
  */
 #define G_TYPE_INITIALLY_UNOWNED             (g_initially_unowned_get_type())
+/**
+ * G_INITIALLY_UNOWNED:
+ * @object: Object which is subject to casting.
+ * 
+ * Casts a #GInitiallyUnowned or derived pointer into a (GInitiallyUnowned*) 
+ * pointer. Depending on the current debugging level, this function may invoke
+ * certain runtime checks to identify invalid casts.
+ */
 #define G_INITIALLY_UNOWNED(object)           (G_TYPE_CHECK_INSTANCE_CAST ((object), G_TYPE_INITIALLY_UNOWNED, GInitiallyUnowned))
+/**
+ * G_INITIALLY_UNOWNED_CLASS:
+ * @class: a valid #GInitiallyUnownedClass
+ * 
+ * Casts a derived #GInitiallyUnownedClass structure into a
+ * #GInitiallyUnownedClass structure.
+ */
 #define G_INITIALLY_UNOWNED_CLASS(class)      (G_TYPE_CHECK_CLASS_CAST ((class), G_TYPE_INITIALLY_UNOWNED, GInitiallyUnownedClass))
+/**
+ * G_IS_INITIALLY_UNOWNED:
+ * @object: Instance to check for being a %G_TYPE_INITIALLY_UNOWNED.
+ * 
+ * Checks whether a valid #GTypeInstance pointer is of type %G_TYPE_INITIALLY_UNOWNED.
+ */
 #define G_IS_INITIALLY_UNOWNED(object)        (G_TYPE_CHECK_INSTANCE_TYPE ((object), G_TYPE_INITIALLY_UNOWNED))
+/**
+ * G_IS_INITIALLY_UNOWNED_CLASS:
+ * @class: a #GInitiallyUnownedClass
+ * 
+ * Checks whether @class "is a" valid #GInitiallyUnownedClass structure of type
+ * %G_TYPE_INITIALLY_UNOWNED or derived.
+ */
 #define G_IS_INITIALLY_UNOWNED_CLASS(class)   (G_TYPE_CHECK_CLASS_TYPE ((class), G_TYPE_INITIALLY_UNOWNED))
+/**
+ * G_INITIALLY_UNOWNED_GET_CLASS:
+ * @object: a #GInitiallyUnowned instance.
+ * 
+ * Get the class structure associated to a #GInitiallyUnowned instance.
+ *
+ * Returns: pointer to object class structure.
+ */
 #define G_INITIALLY_UNOWNED_GET_CLASS(object) (G_TYPE_INSTANCE_GET_CLASS ((object), G_TYPE_INITIALLY_UNOWNED, GInitiallyUnownedClass))
 /* GInitiallyUnowned ia a GObject with initially floating reference count */
 

diff --git a/gobject/gtype.c b/gobject/gtype.c
index 203c7fc..f244829 100644 (file)
--- a/gobject/gtype.c
+++ b/gobject/gtype.c
@@ -3750,6 +3750,15 @@ g_type_check_class_cast (GTypeClass *type_class,
   return type_class;
 }
 
+/*
+ * g_type_check_instance:
+ * @instance: A valid #GTypeInstance structure.
+ *
+ * Private helper function to aid implementation of the G_TYPE_CHECK_INSTANCE()
+ * macro.
+ *
+ * @Returns:  #TRUE if @instance is valid, #FALSE otherwise.
+ */
 gboolean
 g_type_check_instance (GTypeInstance *type_instance)
 {

diff --git a/gobject/gtype.h b/gobject/gtype.h
index 8ae923a..1e9a128 100644 (file)
--- a/gobject/gtype.h
+++ b/gobject/gtype.h
@@ -185,6 +185,11 @@ G_BEGIN_DECLS
  * type IDs with G_TYPE_MAKE_FUNDAMENTAL().
  * Send email to gtk-devel-list@gnome.org for reservations.
  */
+/**
+ * G_TYPE_FUNDAMENTAL_SHIFT:
+ *
+ * Shift value used in converting numbers to type IDs.
+ */
 #define        G_TYPE_FUNDAMENTAL_SHIFT        (2)
 /**
  * G_TYPE_MAKE_FUNDAMENTAL: