[gobject-introspection] [docs] Add struct hierarchy to each section
- From: Johan Dahlin <johan src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gobject-introspection] [docs] Add struct hierarchy to each section
- Date: Fri, 11 Jun 2010 23:20:18 +0000 (UTC)
commit adfbff0516f8c020403ec02f688e179d9386397f
Author: Johan Dahlin <johan gnome org>
Date: Fri Jun 11 20:16:00 2010 -0300
[docs] Add struct hierarchy to each section
girepository/giarginfo.c | 8 +++++++-
girepository/gibaseinfo.c | 15 +++++++++++++++
girepository/gicallableinfo.c | 10 ++++++++++
girepository/giconstantinfo.c | 8 ++++++++
girepository/gienuminfo.c | 9 +++++++++
girepository/gierrordomaininfo.c | 8 ++++++++
girepository/gifieldinfo.c | 8 ++++++++
girepository/gifunctioninfo.c | 11 +++++++++++
girepository/gipropertyinfo.c | 8 ++++++++
girepository/giregisteredtypeinfo.c | 13 +++++++++++++
girepository/gisignalinfo.c | 11 +++++++++++
girepository/gitypeinfo.c | 8 ++++++++
girepository/givfuncinfo.c | 11 +++++++++++
13 files changed, 127 insertions(+), 1 deletions(-)
---
diff --git a/girepository/giarginfo.c b/girepository/giarginfo.c
index 40dcd52..dc1d116 100644
--- a/girepository/giarginfo.c
+++ b/girepository/giarginfo.c
@@ -35,7 +35,13 @@
* 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>
*/
/**
diff --git a/girepository/gibaseinfo.c b/girepository/gibaseinfo.c
index 5cb1532..c8444a5 100644
--- a/girepository/gibaseinfo.c
+++ b/girepository/gibaseinfo.c
@@ -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>
+ *
*/
/**
diff --git a/girepository/gicallableinfo.c b/girepository/gicallableinfo.c
index da6b50b..845b3db 100644
--- a/girepository/gicallableinfo.c
+++ b/girepository/gicallableinfo.c
@@ -39,6 +39,16 @@
* 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
diff --git a/girepository/giconstantinfo.c b/girepository/giconstantinfo.c
index 551e73c..4a3b838 100644
--- a/girepository/giconstantinfo.c
+++ b/girepository/giconstantinfo.c
@@ -33,6 +33,14 @@
* 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>
*/
diff --git a/girepository/gienuminfo.c b/girepository/gienuminfo.c
index ac8f092..9ecbc2a 100644
--- a/girepository/gienuminfo.c
+++ b/girepository/gienuminfo.c
@@ -33,6 +33,15 @@
* 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>
*/
/**
diff --git a/girepository/gierrordomaininfo.c b/girepository/gierrordomaininfo.c
index aa06719..86e40c5 100644
--- a/girepository/gierrordomaininfo.c
+++ b/girepository/gierrordomaininfo.c
@@ -33,6 +33,14 @@
* 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>
*/
/**
diff --git a/girepository/gifieldinfo.c b/girepository/gifieldinfo.c
index a902e6f..14e371f 100644
--- a/girepository/gifieldinfo.c
+++ b/girepository/gifieldinfo.c
@@ -37,6 +37,14 @@
* 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>
*/
/**
diff --git a/girepository/gifunctioninfo.c b/girepository/gifunctioninfo.c
index 3385280..7365370 100644
--- a/girepository/gifunctioninfo.c
+++ b/girepository/gifunctioninfo.c
@@ -39,6 +39,17 @@
*
* 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 *
diff --git a/girepository/gipropertyinfo.c b/girepository/gipropertyinfo.c
index d5cfe22..9fe485c 100644
--- a/girepository/gipropertyinfo.c
+++ b/girepository/gipropertyinfo.c
@@ -32,6 +32,14 @@
*
* 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>
*/
/**
diff --git a/girepository/giregisteredtypeinfo.c b/girepository/giregisteredtypeinfo.c
index fe159cf..cc43d28 100644
--- a/girepository/giregisteredtypeinfo.c
+++ b/girepository/giregisteredtypeinfo.c
@@ -40,6 +40,19 @@
* 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>
*/
/**
diff --git a/girepository/gisignalinfo.c b/girepository/gisignalinfo.c
index 852dd52..b19d98e 100644
--- a/girepository/gisignalinfo.c
+++ b/girepository/gisignalinfo.c
@@ -35,6 +35,17 @@
*
* 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>
*/
/**
diff --git a/girepository/gitypeinfo.c b/girepository/gitypeinfo.c
index 68c3dc1..4904c2b 100644
--- a/girepository/gitypeinfo.c
+++ b/girepository/gitypeinfo.c
@@ -40,6 +40,14 @@
* 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>
+ *
*/
/**
diff --git a/girepository/givfuncinfo.c b/girepository/givfuncinfo.c
index 3990ea9..da86ed4 100644
--- a/girepository/givfuncinfo.c
+++ b/girepository/givfuncinfo.c
@@ -34,6 +34,17 @@
*
* 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 *
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]