mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2024-12-25 23:16:14 +01:00
[docs] Add struct hierarchy to each section
This commit is contained in:
parent
5a0016133a
commit
1eca3abe67
@ -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>
|
||||
*/
|
||||
|
||||
/**
|
||||
|
15
gibaseinfo.c
15
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>
|
||||
*
|
||||
*/
|
||||
|
||||
/**
|
||||
|
@ -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
|
||||
|
@ -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>
|
||||
*/
|
||||
|
||||
|
||||
|
@ -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>
|
||||
*/
|
||||
|
||||
/**
|
||||
|
@ -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>
|
||||
*/
|
||||
|
||||
/**
|
||||
|
@ -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>
|
||||
*/
|
||||
|
||||
/**
|
||||
|
@ -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 *
|
||||
|
@ -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>
|
||||
*/
|
||||
|
||||
/**
|
||||
|
@ -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>
|
||||
*/
|
||||
|
||||
/**
|
||||
|
@ -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>
|
||||
*/
|
||||
|
||||
/**
|
||||
|
@ -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>
|
||||
*
|
||||
*/
|
||||
|
||||
/**
|
||||
|
@ -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 *
|
||||
|
Loading…
Reference in New Issue
Block a user