[docs] Add struct hierarchy to each section
authorJohan Dahlin <johan@gnome.org>
Fri, 11 Jun 2010 23:16:00 +0000 (20:16 -0300)
committerJohan Dahlin <johan@gnome.org>
Fri, 11 Jun 2010 23:16:00 +0000 (20:16 -0300)
13 files changed:
girepository/giarginfo.c
girepository/gibaseinfo.c
girepository/gicallableinfo.c
girepository/giconstantinfo.c
girepository/gienuminfo.c
girepository/gierrordomaininfo.c
girepository/gifieldinfo.c
girepository/gifunctioninfo.c
girepository/gipropertyinfo.c
girepository/giregisteredtypeinfo.c
girepository/gisignalinfo.c
girepository/gitypeinfo.c
girepository/givfuncinfo.c

index 40dcd52..dc1d116 100644 (file)
  * GIArgInfo represents an argument. An argument is always
  * part of a #GICallableInfo.
  *
- *
+ * <refsect1 id="gi-giarginfo.struct-hierarchy" role="struct_hierarchy">
+ * <title role="struct_hierarchy.title">Struct hierarchy</title>
+ * <synopsis>
+ *   <link linkend="gi-GIBaseInfo">GIBaseInfo</link>
+ *    +----GIArgInfo
+ * </synopsis>
+ * </refsect1>
  */
 
 /**
index 5cb1532..c8444a5 100644 (file)
@@ -180,6 +180,21 @@ _g_type_info_init (GIBaseInfo *info,
  * </programlisting>
  * </example>
  *
+ * <refsect1 id="gi-gibaseinfo.struct-hierarchy" role="struct_hierarchy">
+ * <title role="struct_hierarchy.title">Struct hierarchy</title>
+ * <synopsis>
+ *   GIBaseInfo
+ *    +----<link linkend="gi-GIArgInfo">GIArgInfo</link>
+ *    +----<link linkend="gi-GICallableInfo">GICallableInfo</link>
+ *    +----<link linkend="gi-GIConstantInfo">GIConstantInfo</link>
+ *    +----<link linkend="gi-GIErrorDomainInfo">GIErrorDomainInfo</link>
+ *    +----<link linkend="gi-GIFieldInfo">GIFieldInfo</link>
+ *    +----<link linkend="gi-GIPropertyInfo">GIPropertyInfo</link>
+ *    +----<link linkend="gi-GIRegisteredTypeInfo">GIRegisteredTypeInfo</link>
+ *    +----<link linkend="gi-GITypeInfo">GITypeInfo</link>
+ * </synopsis>
+ * </refsect1>
+ *
  */
 
 /**
index da6b50b..845b3db 100644 (file)
  * A callable has a list of arguments (#GIArgInfo), a return type,
  * direction and a flag which decides if it returns null.
  *
+ * <refsect1 id="gi-gicallableinfo.struct-hierarchy" role="struct_hierarchy">
+ * <title role="struct_hierarchy.title">Struct hierarchy</title>
+ * <synopsis>
+ *   <link linkend="gi-GIBaseInfo">GIBaseInfo</link>
+ *    +----GICallableInfo
+ *          +----<link linkend="gi-GIFunctionInfo">GIFunctionInfo</link>
+ *          +----<link linkend="gi-GISignalInfo">GISignalInfo</link>
+ *          +----<link linkend="gi-GIVFuncInfo">GIVFuncInfo</link>
+ * </synopsis>
+ * </refsect1>
  */
 
 static guint32
index 551e73c..4a3b838 100644 (file)
  * GIConstantInfo represents a constant. A constant has a type associated
  * which can be obtained by calling g_constant_info_get_type() and a value,
  * which can be obtained by calling g_constant_info_get_value().
+ *
+ * <refsect1 id="gi-giconstantinfo.struct-hierarchy" role="struct_hierarchy">
+ * <title role="struct_hierarchy.title">Struct hierarchy</title>
+ * <synopsis>
+ *   <link linkend="gi-GIBaseInfo">GIBaseInfo</link>
+ *    +----GIConstantInfo
+ * </synopsis>
+ * </refsect1>
  */
 
 
index ac8f092..9ecbc2a 100644 (file)
  * A GIEnumInfo represents an enumeration and a GIValueInfo struct represents a value
  * of an enumeration. The GIEnumInfo contains a set of values and a type
  * The GIValueInfo is fetched by calling g_enum_info_get_value() on a #GIEnumInfo.
+ *
+ * <refsect1 id="gi-gienuminfo.struct-hierarchy" role="struct_hierarchy">
+ * <title role="struct_hierarchy.title">Struct hierarchy</title>
+ * <synopsis>
+ *   <link linkend="gi-GIBaseInfo">GIBaseInfo</link>
+ *    +----<link linkend="gi-GIRegisteredTypeInfo">GIRegisteredTypeInfo</link>
+ *          +----GIEnumInfo
+ * </synopsis>
+ * </refsect1>
  */
 
 /**
index aa06719..86e40c5 100644 (file)
  * A GIErrorDomainInfo struct represents a domain of a #GError.
  * An error domain is associated with a #GQuark and contains a pointer
  * to an enum with all the error codes.
+ *
+ * <refsect1 id="gi-gierrordomaininfo.struct-hierarchy" role="struct_hierarchy">
+ * <title role="struct_hierarchy.title">Struct hierarchy</title>
+ * <synopsis>
+ *   <link linkend="gi-GIBaseInfo">GIBaseInfo</link>
+ *    +----GIErrorDomainInfo
+ * </synopsis>
+ * </refsect1>
  */
 
 /**
index a902e6f..14e371f 100644 (file)
  * or g_object_info_get_value().
  * A field has a size, type and a struct offset asssociated and a set of flags,
  * which is currently #GI_FIELD_IS_READABLE or #GI_FIELD_IS_WRITABLE.
+ *
+ * <refsect1 id="gi-gifieldinfo.struct-hierarchy" role="struct_hierarchy">
+ * <title role="struct_hierarchy.title">Struct hierarchy</title>
+ * <synopsis>
+ *   <link linkend="gi-GIBaseInfo">GIBaseInfo</link>
+ *    +----GIFieldInfo
+ * </synopsis>
+ * </refsect1>
  */
 
 /**
index 3385280..7365370 100644 (file)
  *
  * See also #GICallableInfo for information on how to retreive arguments and
  * other metadata.
+ *
+ * <refsect1 id="gi-gifunctioninfo.struct-hierarchy" role="struct_hierarchy">
+ * <title role="struct_hierarchy.title">Struct hierarchy</title>
+ * <synopsis>
+ *   <link linkend="gi-GIBaseInfo">GIBaseInfo</link>
+ *    +----<link linkend="gi-GICallableInfo">GICallableInfo</link>
+ *          +----GIFunctionInfo
+ *          +----<link linkend="gi-GISignalInfo">GISignalInfo</link>
+ *          +----<link linkend="gi-GIVFuncInfo">GIVFuncInfo</link>
+ * </synopsis>
+ * </refsect1>
  */
 
 GIFunctionInfo *
index d5cfe22..9fe485c 100644 (file)
  *
  * GIPropertyInfo represents a property. A property belongs to
  * either a #GIObjectInfo or a #GIInterfaceInfo.
+ *
+ * <refsect1 id="gi-gipropertyinfo.struct-hierarchy" role="struct_hierarchy">
+ * <title role="struct_hierarchy.title">Struct hierarchy</title>
+ * <synopsis>
+ *   <link linkend="gi-GIBaseInfo">GIBaseInfo</link>
+ *    +----GIPropertyInfo
+ * </synopsis>
+ * </refsect1>
  */
 
 /**
index fe159cf..cc43d28 100644 (file)
  * To get the name call g_registered_type_info_get_type_name().
  * Most users want to call g_registered_type_info_get_g_type() and don't worry
  * about the rest of the details.
+ *
+ * <refsect1 id="gi-giregisteredtypeinfo.struct-hierarchy" role="struct_hierarchy">
+ * <title role="struct_hierarchy.title">Struct hierarchy</title>
+ * <synopsis>
+ *   <link linkend="gi-GIBaseInfo">GIBaseInfo</link>
+ *    +----GIRegisteredTypeInfo
+ *          +----<link linkend="gi-GIEnumInfo">GIEnumInfo</link>
+ *          +----<link linkend="gi-GIInterfaceInfo">GIInterfaceInfo</link>
+ *          +----<link linkend="gi-GIObjectInfo">GIObjectInfo</link>
+ *          +----<link linkend="gi-GIStructInfo">GIStructInfo</link>
+ *          +----<link linkend="gi-GIUnionInfo">GIUnionInfo</link>
+ * </synopsis>
+ * </refsect1>
  */
 
 /**
index 852dd52..b19d98e 100644 (file)
  *
  * See #GICallableInfo for information on how to retreive arguments
  * and other metadata from the signal.
+ *
+ * <refsect1 id="gi-gisignalinfo.struct-hierarchy" role="struct_hierarchy">
+ * <title role="struct_hierarchy.title">Struct hierarchy</title>
+ * <synopsis>
+ *   <link linkend="gi-GIBaseInfo">GIBaseInfo</link>
+ *    +----<link linkend="gi-GICallableInfo">GICallableInfo</link>
+ *          +----<link linkend="gi-GIFunctionInfo">GIFunctionInfo</link>
+ *          +----GISignalInfo
+ *          +----<link linkend="gi-GIVFuncInfo">GIVFuncInfo</link>
+ * </synopsis>
+ * </refsect1>
  */
 
 /**
index 68c3dc1..4904c2b 100644 (file)
  * g_type_info_get_interface() to get a reference to the base info for that
  * interface.
  *
+ * <refsect1 id="gi-gitypeinfo.struct-hierarchy" role="struct_hierarchy">
+ * <title role="struct_hierarchy.title">Struct hierarchy</title>
+ * <synopsis>
+ *   <link linkend="gi-GIBaseInfo">GIBaseInfo</link>
+ *    +----GITypeInfo
+ * </synopsis>
+ * </refsect1>
+ *
  */
 
 /**
index 3990ea9..da86ed4 100644 (file)
  *
  * GIVfuncInfo represents a virtual function. A property belongs to
  * either a #GIObjectInfo or a #GIInterfaceInfo.
+ *
+ * <refsect1 id="gi-givfuncinfo.struct-hierarchy" role="struct_hierarchy">
+ * <title role="struct_hierarchy.title">Struct hierarchy</title>
+ * <synopsis>
+ *   <link linkend="gi-GIBaseInfo">GIBaseInfo</link>
+ *    +----<link linkend="gi-GICallableInfo">GICallableInfo</link>
+ *          +----<link linkend="gi-GIFunctionInfo">GIFunctionInfo</link>
+ *          +----<link linkend="gi-GISignalInfo">GISignalInfo</link>
+ *          +----GIVFuncInfo
+ * </synopsis>
+ * </refsect1>
  */
 
 GIVFuncInfo *