summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohan Dahlin <jdahlin@litl.com>2010-05-18 18:39:25 -0300
committerJohan Dahlin <johan@gnome.org>2010-05-18 18:39:25 -0300
commit9f93d98f150fe00c05d3472de3e5a4f82657c803 (patch)
treeeb29ab3ffa00f355e3b6abb7aa06941bac567775
parent85a6b48602bc3e8e68e1048de375fc32ae825347 (diff)
downloadgobject-introspection-9f93d98f150fe00c05d3472de3e5a4f82657c803.tar.gz
[docs] Reorganize structs into chapters
Instead of displaying all structures and methods in girepository.h on one page, split them out to a bunch of pages.
-rw-r--r--docs/reference/gi-docs.sgml38
-rw-r--r--docs/reference/gi-sections.txt322
2 files changed, 237 insertions, 123 deletions
diff --git a/docs/reference/gi-docs.sgml b/docs/reference/gi-docs.sgml
index 4441d737..08a9779d 100644
--- a/docs/reference/gi-docs.sgml
+++ b/docs/reference/gi-docs.sgml
@@ -31,11 +31,39 @@ Bla bla bla bla bla
</chapter>
-->
- <chapter id="gi-repository">
- <title>GIRepository</title>
- <xi:include href="xml/girepository.xml"/>
- <xi:include href="xml/girffi.xml"/>
- </chapter>
+ <part id="girepository">
+ <chapter id="gi-libgirepository">
+ <title>GIRepository</title>
+ <xi:include href="xml/girepository.xml"/>
+ </chapter>
+ <chapter id="gi-ffi">
+ <title>GIR Foreign functions interface</title>
+ <xi:include href="xml/girffi.xml"/>
+ </chapter>
+ <chapter id="gi-repository-structs">
+ <title>GIRepository structs</title>
+ <xi:include href="xml/gibaseinfo.xml"/>
+ <xi:include href="xml/gifunctioninfo.xml"/>
+ <xi:include href="xml/gicallableinfo.xml"/>
+ <xi:include href="xml/giarginfo.xml"/>
+ <xi:include href="xml/gitypeinfo.xml"/>
+ <xi:include href="xml/gistructinfo.xml"/>
+ <xi:include href="xml/giunioninfo.xml"/>
+ <xi:include href="xml/gifieldinfo.xml"/>
+ <xi:include href="xml/gipropertyinfo.xml"/>
+ <xi:include href="xml/givfuncinfo.xml"/>
+ <xi:include href="xml/gisignalinfo.xml"/>
+ <xi:include href="xml/gienuminfo.xml"/>
+ <xi:include href="xml/giregisteredtypeinfo.xml"/>
+ <xi:include href="xml/giobjectinfo.xml"/>
+ <xi:include href="xml/giinterfaceinfo.xml"/>
+ <xi:include href="xml/giconstantinfo.xml"/>
+ <xi:include href="xml/gifunctioninfo.xml"/>
+ <xi:include href="xml/gierrordomaininfo.xml"/>
+ </chapter>
+
+ </part>
+
<part id="gi-gir">
<title>GIR markup format</title>
diff --git a/docs/reference/gi-sections.txt b/docs/reference/gi-sections.txt
index b481896f..8abaf298 100644
--- a/docs/reference/gi-sections.txt
+++ b/docs/reference/gi-sections.txt
@@ -1,27 +1,10 @@
<SECTION>
<FILE>girepository</FILE>
+<TITLE></TITLE>
G_TYPE_IREPOSITORY
G_IREPOSITORY
GIRepositoryPrivate
-GIBaseInfo
-GICallableInfo
-GIFunctionInfo
GICallbackInfo
-GIRegisteredTypeInfo
-GIStructInfo
-GIUnionInfo
-GIEnumInfo
-GIObjectInfo
-GIInterfaceInfo
-GIConstantInfo
-GIValueInfo
-GISignalInfo
-GIVFuncInfo
-GIPropertyInfo
-GIFieldInfo
-GIArgInfo
-GITypeInfo
-GIErrorDomainInfo
GIUnresolvedInfo
GTypelib
GIArrayType
@@ -62,6 +45,21 @@ G_IREPOSITORY_ERROR
g_irepository_error_quark
gi_cclosure_marshal_generic
GIInfoType
+g_info_new
+G_INVOKE_ERROR
+g_invoke_error_quark
+GITransfer
+GIDirection
+GIScopeType
+<SUBSECTION Standard>
+G_TYPE_TAG_IS_BASIC
+g_irepository_get_type
+</SECTION>
+
+<SECTION>
+<FILE>gibaseinfo</FILE>
+<TITLE>BaseInfo</TITLE>
+GIBaseInfo
g_base_info_ref
g_base_info_unref
g_base_info_get_type
@@ -73,17 +71,14 @@ g_base_info_iterate_attributes
g_base_info_get_container
g_base_info_get_typelib
g_base_info_equal
-g_info_new
-GIFunctionInfoFlags
-g_function_info_get_symbol
-g_function_info_get_flags
-g_function_info_get_property
-g_function_info_get_vfunc
-G_INVOKE_ERROR
-g_invoke_error_quark
-GInvokeError
-g_function_info_invoke
-GITransfer
+<SUBSECTION Private>
+GIBaseInfoStub
+</SECTION>
+
+<SECTION>
+<FILE>gicallableinfo</FILE>
+<TITLE>Callable</TITLE>
+GICallableInfo
g_callable_info_get_return_type
g_callable_info_get_caller_owns
g_callable_info_may_return_null
@@ -91,8 +86,161 @@ g_callable_info_get_n_args
g_callable_info_get_arg
g_callable_info_load_arg
g_callable_info_load_return_type
-GIDirection
-GIScopeType
+</SECTION>
+
+<SECTION>
+<FILE>giconstantinfo</FILE>
+<TITLE>Constant</TITLE>
+GIConstantInfo
+g_constant_info_get_type
+g_constant_info_get_value
+</SECTION>
+
+<SECTION>
+<FILE>givfuncinfo</FILE>
+<TITLE>Virtual Function</TITLE>
+GIVFuncInfo
+GIVFuncInfoFlags
+g_vfunc_info_get_flags
+g_vfunc_info_get_offset
+g_vfunc_info_get_signal
+g_vfunc_info_get_invoker
+</SECTION>
+
+<SECTION>
+<FILE>gisignalinfo</FILE>
+<TITLE>Signal</TITLE>
+GISignalInfo
+g_signal_info_get_flags
+g_signal_info_get_class_closure
+g_signal_info_true_stops_emit
+</SECTION>
+
+<SECTION>
+<FILE>gipropertyinfo</FILE>
+<TITLE>Property</TITLE>
+GIPropertyInfo
+g_property_info_get_flags
+g_property_info_get_type
+</SECTION>
+
+<SECTION>
+<FILE>giinterfaceinfo</FILE>
+<TITLE>Interface</TITLE>
+GIInterfaceInfo
+g_interface_info_get_n_prerequisites
+g_interface_info_get_prerequisite
+g_interface_info_get_n_properties
+g_interface_info_get_property
+g_interface_info_get_n_methods
+g_interface_info_get_method
+g_interface_info_find_method
+g_interface_info_get_n_signals
+g_interface_info_get_signal
+g_interface_info_get_n_vfuncs
+g_interface_info_get_vfunc
+g_interface_info_get_n_constants
+g_interface_info_get_constant
+g_interface_info_get_iface_struct
+g_interface_info_find_vfunc
+</SECTION>
+
+<SECTION>
+<FILE>giobjectinfo</FILE>
+<TITLE>Object</TITLE>
+GIObjectInfo
+g_object_info_get_type_name
+g_object_info_get_type_init
+g_object_info_get_abstract
+g_object_info_get_parent
+g_object_info_get_n_interfaces
+g_object_info_get_interface
+g_object_info_get_n_fields
+g_object_info_get_field
+g_object_info_get_n_properties
+g_object_info_get_property
+g_object_info_get_n_methods
+g_object_info_get_method
+g_object_info_find_method
+g_object_info_get_n_signals
+g_object_info_get_signal
+g_object_info_get_n_vfuncs
+g_object_info_get_vfunc
+g_object_info_get_n_constants
+g_object_info_get_constant
+g_object_info_get_class_struct
+g_object_info_find_vfunc
+</SECTION>
+
+<SECTION>
+<FILE>gienuminfo</FILE>
+<TITLE>Enum and Flags</TITLE>
+GIEnumInfo
+GIValueInfo
+g_enum_info_get_n_values
+g_enum_info_get_value
+g_enum_info_get_storage_type
+g_value_info_get_value
+</SECTION>
+
+<SECTION>
+<FILE>giregisteredtypeinfo</FILE>
+<TITLE>Registered type</TITLE>
+GIRegisteredTypeInfo
+g_registered_type_info_get_type_name
+g_registered_type_info_get_type_init
+g_registered_type_info_get_g_type
+</SECTION>
+
+<SECTION>
+<FILE>gistructinfo</FILE>
+<TITLE>Struct</TITLE>
+GIStructInfo
+g_struct_info_get_n_fields
+g_struct_info_get_field
+g_struct_info_get_n_methods
+g_struct_info_get_method
+g_struct_info_find_method
+g_struct_info_get_size
+g_struct_info_get_alignment
+g_struct_info_is_gtype_struct
+g_struct_info_is_foreign
+</SECTION>
+
+<SECTION>
+<FILE>giunioninfo</FILE>
+<TITLE>Union</TITLE>
+GIUnionInfo
+g_union_info_get_n_fields
+g_union_info_get_field
+g_union_info_get_n_methods
+g_union_info_get_method
+g_union_info_is_discriminated
+g_union_info_get_discriminator_offset
+g_union_info_get_discriminator_type
+g_union_info_get_discriminator
+g_union_info_find_method
+g_union_info_get_size
+g_union_info_get_alignment
+</SECTION>
+
+<SECTION>
+<FILE>gifieldinfo</FILE>
+<TITLE>Field</TITLE>
+GIFieldInfo
+GIFieldInfoFlags
+g_field_info_get_flags
+g_field_info_get_size
+g_field_info_get_offset
+g_field_info_get_type
+g_field_info_get_field
+g_field_info_set_field
+</SECTION>
+
+<SECTION>
+<FILE>giarginfo</FILE>
+<TITLE>Argument</TITLE>
+GIArgInfo
g_arg_info_get_direction
g_arg_info_is_dipper
g_arg_info_is_return_value
@@ -104,6 +252,12 @@ g_arg_info_get_closure
g_arg_info_get_destroy
g_arg_info_get_type
g_arg_info_load_type
+</SECTION>
+
+<SECTION>
+<FILE>gitypeinfo</FILE>
+<TITLE>Type</TITLE>
+GITypeInfo
GITypeTag
g_type_tag_to_string
g_type_info_is_pointer
@@ -116,95 +270,27 @@ g_type_info_is_zero_terminated
g_type_info_get_n_error_domains
g_type_info_get_error_domain
g_type_info_get_array_type
+</SECTION>
+
+<SECTION>
+<FILE>gifunctioninfo</FILE>
+<TITLE>Function</TITLE>
+GIFunctionInfo
+GInvokeError
+GIFunctionInfoFlags
+g_function_info_get_symbol
+g_function_info_get_flags
+g_function_info_get_property
+g_function_info_get_vfunc
+g_function_info_invoke
+</SECTION>
+
+<SECTION>
+<FILE>gierrordomaininfo</FILE>
+<TITLE>Error domain</TITLE>
+GIErrorDomainInfo
g_error_domain_info_get_quark
g_error_domain_info_get_codes
-g_value_info_get_value
-GIFieldInfoFlags
-g_field_info_get_flags
-g_field_info_get_size
-g_field_info_get_offset
-g_field_info_get_type
-g_field_info_get_field
-g_field_info_set_field
-g_union_info_get_n_fields
-g_union_info_get_field
-g_union_info_get_n_methods
-g_union_info_get_method
-g_union_info_is_discriminated
-g_union_info_get_discriminator_offset
-g_union_info_get_discriminator_type
-g_union_info_get_discriminator
-g_union_info_find_method
-g_union_info_get_size
-g_union_info_get_alignment
-g_struct_info_get_n_fields
-g_struct_info_get_field
-g_struct_info_get_n_methods
-g_struct_info_get_method
-g_struct_info_find_method
-g_struct_info_get_size
-g_struct_info_get_alignment
-g_struct_info_is_gtype_struct
-g_struct_info_is_foreign
-g_registered_type_info_get_type_name
-g_registered_type_info_get_type_init
-g_registered_type_info_get_g_type
-g_enum_info_get_n_values
-g_enum_info_get_value
-g_enum_info_get_storage_type
-g_object_info_get_type_name
-g_object_info_get_type_init
-g_object_info_get_abstract
-g_object_info_get_parent
-g_object_info_get_n_interfaces
-g_object_info_get_interface
-g_object_info_get_n_fields
-g_object_info_get_field
-g_object_info_get_n_properties
-g_object_info_get_property
-g_object_info_get_n_methods
-g_object_info_get_method
-g_object_info_find_method
-g_object_info_get_n_signals
-g_object_info_get_signal
-g_object_info_get_n_vfuncs
-g_object_info_get_vfunc
-g_object_info_get_n_constants
-g_object_info_get_constant
-g_object_info_get_class_struct
-g_object_info_find_vfunc
-g_interface_info_get_n_prerequisites
-g_interface_info_get_prerequisite
-g_interface_info_get_n_properties
-g_interface_info_get_property
-g_interface_info_get_n_methods
-g_interface_info_get_method
-g_interface_info_find_method
-g_interface_info_get_n_signals
-g_interface_info_get_signal
-g_interface_info_get_n_vfuncs
-g_interface_info_get_vfunc
-g_interface_info_get_n_constants
-g_interface_info_get_constant
-g_interface_info_get_iface_struct
-g_interface_info_find_vfunc
-g_property_info_get_flags
-g_property_info_get_type
-g_signal_info_get_flags
-g_signal_info_get_class_closure
-g_signal_info_true_stops_emit
-GIVFuncInfoFlags
-g_vfunc_info_get_flags
-g_vfunc_info_get_offset
-g_vfunc_info_get_signal
-g_vfunc_info_get_invoker
-g_constant_info_get_type
-g_constant_info_get_value
-<SUBSECTION Standard>
-G_TYPE_TAG_IS_BASIC
-g_irepository_get_type
-<SUBSECTION Private>
-GIBaseInfoStub
</SECTION>
<SECTION>