Commit 60d032a6 authored by Owen Taylor's avatar Owen Taylor Committed by Owen Taylor

Split GObject docs away from the remainder of the docs.

Wed Sep  6 00:30:09 2000  Owen Taylor  <otaylor@redhat.com>

	* glib/* gobject/*: Split GObject docs away from
	the remainder of the docs.

	* glib/Makefile.am gobject/Makefile.am: Rework
	to have reasonable dependencies. (No dependencies
	on the files actually in the source directories,
	so to get it going, you have to do 'make scan',
	but after that, things should work OK.)
parent 8cc4771f
glib-unused.txt
glib-decl-list.txt
glib-decl.txt
html
sgml
\ No newline at end of file
......@@ -16,12 +16,14 @@ tmpl_sources = \
tmpl/arrays.sgml \
tmpl/arrays_byte.sgml \
tmpl/arrays_pointer.sgml \
tmpl/async_queues.sgml \
tmpl/byte_order.sgml \
tmpl/caches.sgml \
tmpl/completion.sgml \
tmpl/datalist.sgml \
tmpl/datasets.sgml \
tmpl/date.sgml \
tmpl/error_reporting.sgml \
tmpl/glib-unused.sgml \
tmpl/hash_tables.sgml \
tmpl/hooks.sgml \
......@@ -37,41 +39,56 @@ tmpl_sources = \
tmpl/messages.sgml \
tmpl/misc_utils.sgml \
tmpl/modules.sgml \
tmpl/numerical.sgml \
tmpl/quarks.sgml \
tmpl/queue.sgml \
tmpl/random_numbers.sgml \
tmpl/relations.sgml \
tmpl/scanner.sgml \
tmpl/string_chunks.sgml \
tmpl/string_utils.sgml \
tmpl/strings.sgml \
tmpl/thread_pools.sgml \
tmpl/threads.sgml \
tmpl/timers.sgml \
tmpl/trash_stack.sgml \
tmpl/trees-binary.sgml \
tmpl/trees-nary.sgml \
tmpl/type_conversion.sgml \
tmpl/types.sgml \
tmpl/unicode.sgml \
tmpl/warnings.sgml \
tmpl/windows.sgml
glib_docdir = $(HTML_DIR)
glib_doc_DATA = \
glib-decl.txt \
glib-sections.txt \
glib-overrides.txt
EXTRA_DIST = \
$(glib_doc_DATA)
html/book1.html: sgml/glib-doc.bottom
$(MAKE) html
if ENABLE_GTK_DOC
all-local: html/index.html
glib-decl.txt:
$(MAKE) scan
$(tmpl_sources): glib-decl.txt glib-sections.txt glib-overrides.txt
$(MAKE) templates
sgml/glib-doc.bottom: $(tmpl_sources)
sgml/glib-doc.bottom: $(tmpl_sources) glib-decl.txt
$(MAKE) sgml
html/index.html: sgml/glib-doc.bottom
$(MAKE) html
endif
scan:
-(cd $(srcdir) \
&& gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="config.h gmoduleconf.h gunidecomp.h gunichartables.h glibconfig-sysdefs.h" )
&& gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="gobject config.h gmoduleconf.h gunidecomp.h gunichartables.h glibconfig-sysdefs.h" )
templates: scan
templates:
cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE)
sgml:
......@@ -81,6 +98,8 @@ sgml:
html:
test -d $(srcdir)/html || mkdir $(srcdir)/html
-cd $(srcdir)/html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
@echo '-- Fixing Crossreferences'
gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR)
clean-local:
rm -f *~ *.bak *.signals *-unused.txt
......@@ -100,8 +119,6 @@ install-data-local:
done; \
echo '-- Installing $(srcdir)/html/index.sgml' ; \
$(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR); \
echo '-- Fixing Crossreferences' ; \
gtkdoc-fixxref --module=$(DOC_MODULE) --html-dir=$(HTML_DIR)|| true; \
fi)
dist-hook:
......
This diff is collapsed.
......@@ -4,16 +4,22 @@
<!entity glib-Standard-Macros SYSTEM "sgml/macros.sgml">
<!entity glib-Type-Conversion-Macros SYSTEM "sgml/type_conversion.sgml">
<!entity glib-Byte-Order-Macros SYSTEM "sgml/byte_order.sgml">
<!entity glib-Numerical-Definitions SYSTEM "sgml/numerical.sgml">
<!entity glib-Miscellaneous-Macros SYSTEM "sgml/macros_misc.sgml">
<!entity glib-Memory-Allocation SYSTEM "sgml/memory.sgml">
<!entity glib-Error-Reporting SYSTEM "sgml/error_reporting.sgml">
<!entity glib-Warnings-and-Assertions SYSTEM "sgml/warnings.sgml">
<!entity glib-Message-Logging SYSTEM "sgml/messages.sgml">
<!entity glib-Timers SYSTEM "sgml/timers.sgml">
<!entity glib-String-Utility-Functions SYSTEM "sgml/string_utils.sgml">
<!entity glib-Unicode-Manipulation SYSTEM "sgml/unicode.sgml">
<!entity glib-Random-Numbers SYSTEM "sgml/random_numbers.sgml">
<!entity glib-Miscellaneous-Utility-Functions SYSTEM "sgml/misc_utils.sgml">
<!entity glib-Date-and-Time-Functions SYSTEM "sgml/date.sgml">
<!entity glib-The-Main-Event-Loop SYSTEM "sgml/main.sgml">
<!entity glib-Threads SYSTEM "sgml/threads.sgml">
<!entity glib-Thread-Pools SYSTEM "sgml/thread_pools.sgml">
<!entity glib-Async-Queues SYSTEM "sgml/async_queues.sgml">
<!entity glib-IO-Channels SYSTEM "sgml/iochannels.sgml">
<!entity glib-Hook-Functions SYSTEM "sgml/hooks.sgml">
<!entity glib-Lexical-Scanner SYSTEM "sgml/scanner.sgml">
......@@ -23,6 +29,8 @@
<!entity glib-Memory-Chunks SYSTEM "sgml/memory_chunks.sgml">
<!entity glib-Doubly-Linked-Lists SYSTEM "sgml/linked_lists_double.sgml">
<!entity glib-Singly-Linked-Lists SYSTEM "sgml/linked_lists_single.sgml">
<!entity glib-Double-ended-Queues SYSTEM "sgml/queue.sgml">
<!entity glib-Trash-Stacks SYSTEM "sgml/trash_stack.sgml">
<!entity glib-Hash-Tables SYSTEM "sgml/hash_tables.sgml">
<!entity glib-Strings SYSTEM "sgml/strings.sgml">
<!entity glib-String-Chunks SYSTEM "sgml/string_chunks.sgml">
......@@ -50,6 +58,7 @@
&glib-Standard-Macros;
&glib-Type-Conversion-Macros;
&glib-Byte-Order-Macros;
&glib-Numerical-Definitions;
&glib-Miscellaneous-Macros;
</chapter>
......@@ -57,9 +66,12 @@
<title>GLib Core Application Support</title>
&glib-The-Main-Event-Loop;
&glib-Threads;
&glib-Thread-Pools;
&glib-Async-Queues;
&glib-Dynamic-Loading-of-Modules;
&glib-Memory-Allocation;
&glib-IO-Channels;
&glib-Error-Reporting;
&glib-Warnings-and-Assertions;
&glib-Message-Logging;
</chapter>
......@@ -67,7 +79,9 @@
<chapter id="glib-utilities">
<title>GLib Utilities</title>
&glib-String-Utility-Functions;
&glib-Unicode-Manipulation;
&glib-Date-and-Time-Functions;
&glib-Random-Numbers;
&glib-Hook-Functions;
&glib-Miscellaneous-Utility-Functions;
&glib-Lexical-Scanner;
......@@ -81,6 +95,8 @@
&glib-Memory-Chunks;
&glib-Doubly-Linked-Lists;
&glib-Singly-Linked-Lists;
&glib-Double-ended-Queues;
&glib-Trash-Stacks;
&glib-Hash-Tables;
&glib-Strings;
&glib-String-Chunks;
......
......@@ -39,10 +39,8 @@ gdouble
gsize
gssize
<SUBSECTION>
gstring
<SUBSECTION Private>
gstring
gldouble
</SECTION>
......@@ -1136,7 +1134,7 @@ g_slist_pop_allocator
</SECTION>
<SECTION>
<TITLE>Doubly-ended Queues</TITLE>
<TITLE>Double-ended Queues</TITLE>
<FILE>queue</FILE>
GQueue
......@@ -1504,9 +1502,6 @@ g_random_double_range
<SECTION>
<TITLE>Unicode Manipulation</TITLE>
<FILE>unicode</FILE>
<SECTION>
<FILE>gunicode</FILE>
gunichar
gunichar2
......@@ -1560,321 +1555,3 @@ g_ucs4_to_utf16
g_ucs4_to_utf8
g_unichar_to_utf8
</SECTION>
<SECTION>
<TITLE>Type Information</TITLE>
<FILE>types</FILE>
GType
G_TYPE_FUNDAMENTAL
G_TYPE_FUNDAMENTAL_MAX
G_TYPE_DERIVE_ID
G_TYPE_BRANCH_SEQNO
G_TYPE_FUNDAMENTAL_LAST
GTypeFundamentals
G_TYPE_IS_CLASSED
G_TYPE_IS_INSTANTIATABLE
G_TYPE_IS_DERIVABLE
G_TYPE_IS_DEEP_DERIVABLE
G_TYPE_IS_PARAM
G_TYPE_IS_INTERFACE
GTypePlugin
GTypePluginVTable
GTypeInterface
GTypeInstance
GTypeInfo
GTypeFundamentalInfo
GInterfaceInfo
GTypeValueTable
<TITLE>GType</TITLE>
G_TYPE_CHECK_INSTANCE_CAST
G_TYPE_CHECK_CLASS_CAST
G_TYPE_CHECK_INSTANCE_TYPE
G_TYPE_CHECK_CLASS_TYPE
G_TYPE_INSTANCE_GET_CLASS
G_TYPE_FROM_INSTANCE
G_TYPE_FROM_CLASS
G_TYPE_FROM_INTERFACE
g_type_init
g_type_name
g_type_qname
g_type_from_name
g_type_parent
g_type_next_base
g_type_is_a
g_type_conforms_to
g_type_fundamental_branch_last
g_type_class_ref
g_type_class_peek
g_type_class_unref
g_type_class_peek_parent
g_type_interface_peek
g_type_children
g_type_interfaces
g_type_set_qdata
g_type_get_qdata
GBaseInitFunc
GBaseFinalizeFunc
GClassInitFunc
GClassFinalizeFunc
GInstanceInitFunc
GInterfaceInitFunc
GInterfaceFinalizeFunc
GTypePluginRef
GTypePluginUnRef
GTypePluginFillTypeInfo
GTypePluginFillInterfaceInfo
GTypeClassCacheFunc
GTypeFlags
g_type_register_static
g_type_register_dynamic
g_type_register_fundamental
g_type_add_interface_static
g_type_add_interface_dynamic
g_type_class_is_a
g_type_check_class_cast
g_type_check_instance_cast
g_type_instance_conforms_to
g_type_check_flags
g_type_create_instance
g_type_free_instance
g_type_value_table_peek
g_type_add_class_cache_func
g_type_remove_class_cache_func
g_type_class_unref_uncached
g_type_get_plugin
g_type_fundamental_last
<SUBSECTION Private>
g_log_domain_gobject
</SECTION>
<SECTION>
<TITLE>The Base Object Type</TITLE>
<FILE>objects</FILE>
GObject
GObjectClass
G_OBJECT
G_OBJECT_GET_CLASS
G_OBJECT_TYPE
G_OBJECT_TYPE_NAME
G_OBJECT_CLASS_TYPE
G_OBJECT_CLASS_NAME
G_IS_VALUE_OBJECT
G_TYPE_IS_OBJECT
G_IS_OBJECT
G_OBJECT_CLASS
G_IS_OBJECT_CLASS
G_NOTIFY_PRIORITY
GObjectGetParamFunc
GObjectSetParamFunc
GObjectFinalizeFunc
g_object_class_install_param
g_object_class_find_param_spec
g_object_new
g_object_new_valist
g_object_set
g_object_get
g_object_set_valist
g_object_get_valist
g_object_set_param
g_object_get_param
g_object_queue_param_changed
g_object_ref
g_object_unref
g_object_get_qdata
g_object_set_qdata
g_object_set_qdata_full
g_object_steal_qdata
g_value_set_object
g_value_get_object
g_value_dup_object
G_WARN_INVALID_PARAM_ID
</SECTION>
<SECTION>
<TITLE>Enumeration and Flag Types</TITLE>
<FILE>enumerations_flags</FILE>
GEnumClass
GFlagsClass
G_ENUM_CLASS_TYPE
G_ENUM_CLASS_TYPE_NAME
G_TYPE_IS_ENUM
G_ENUM_CLASS
G_IS_ENUM_CLASS
G_TYPE_IS_FLAGS
G_FLAGS_CLASS
G_IS_FLAGS_CLASS
G_FLAGS_CLASS_TYPE
G_FLAGS_CLASS_TYPE_NAME
G_IS_VALUE_ENUM
G_IS_VALUE_FLAGS
GEnumValue
GFlagsValue
g_enum_get_value
g_enum_get_value_by_name
g_enum_get_value_by_nick
g_flags_get_first_value
g_flags_get_value_by_name
g_flags_get_value_by_nick
g_value_set_enum
g_value_get_enum
g_value_set_flags
g_value_get_flags
g_enum_register_static
g_flags_register_static
g_enum_complete_type_info
g_flags_complete_type_info
</SECTION>
<SECTION>
<TITLE>Generic values</TITLE>
<FILE>generic_values</FILE>
G_VALUE_TYPE
G_VALUE_TYPE_NAME
G_TYPE_IS_VALUE
G_IS_VALUE
GValueExchange
GValue
g_value_init
g_value_copy
g_value_convert
g_value_reset
g_value_unset
g_values_exchange
g_value_types_exchangable
g_value_register_exchange_func
</SECTION>
<SECTION>
<TITLE>Standard value types</TITLE>
<FILE>value_types</FILE>
G_IS_VALUE_CHAR
G_IS_VALUE_UCHAR
G_IS_VALUE_BOOLEAN
G_IS_VALUE_INT
G_IS_VALUE_UINT
G_IS_VALUE_LONG
G_IS_VALUE_ULONG
G_IS_VALUE_FLOAT
G_IS_VALUE_DOUBLE
G_IS_VALUE_STRING
g_value_set_char
g_value_get_char
g_value_set_uchar
g_value_get_uchar
g_value_set_boolean
g_value_get_boolean
g_value_set_int
g_value_get_int
g_value_set_uint
g_value_get_uint
g_value_set_long
g_value_get_long
g_value_set_ulong
g_value_get_ulong
g_value_set_float
g_value_get_float
g_value_set_double
g_value_get_double
g_value_set_string
g_value_get_string
g_value_dup_string
</SECTION>
<SECTION>
<TITLE>Object Parameter Specifications</TITLE>
<FILE>param_specs</FILE>
GParamSpec
GParamSpecClass
G_PARAM_SPEC_TYPE
G_PARAM_SPEC_TYPE_NAME
G_PARAM_SPEC
G_IS_PARAM_SPEC
G_PARAM_SPEC_GET_CLASS
G_IS_PARAM_VALUE
G_PARAM_SPEC_VALUE_TYPE
G_TYPE_IS_PARAM
GParamFlags
g_param_spec_ref
g_param_spec_unref
g_param_spec_get_qdata
g_param_spec_set_qdata
g_param_spec_set_qdata_full
g_param_spec_steal_qdata
g_param_value_set_default
g_param_value_defaults
g_param_value_validate
g_param_values_cmp
g_param_spec_internal
g_param_spec_hash_table_new
g_param_spec_hash_table_insert
g_param_spec_hash_table_remove
g_param_spec_hash_table_lookup
</SECTION>
<SECTION>
<TITLE>Standard Parameter Types</TITLE>
<FILE>standard_params</FILE>
G_IS_PARAM_SPEC_CHAR
G_PARAM_SPEC_CHAR
G_IS_PARAM_SPEC_UCHAR
G_PARAM_SPEC_UCHAR
G_IS_PARAM_SPEC_BOOLEAN
G_PARAM_SPEC_BOOLEAN
G_IS_PARAM_SPEC_INT
G_PARAM_SPEC_INT
G_IS_PARAM_SPEC_UINT
G_PARAM_SPEC_UINT
G_IS_PARAM_SPEC_LONG
G_PARAM_SPEC_LONG
G_IS_PARAM_SPEC_ULONG
G_PARAM_SPEC_ULONG
G_IS_PARAM_SPEC_ENUM
G_PARAM_SPEC_ENUM
G_IS_PARAM_SPEC_FLAGS
G_PARAM_SPEC_FLAGS
G_IS_PARAM_SPEC_FLOAT
G_PARAM_SPEC_FLOAT
G_IS_PARAM_SPEC_DOUBLE
G_PARAM_SPEC_DOUBLE
G_IS_PARAM_SPEC_STRING
G_PARAM_SPEC_STRING
G_IS_PARAM_SPEC_OBJECT
G_PARAM_SPEC_OBJECT
GParamSpecChar
GParamSpecUChar
GParamSpecBoolean
GParamSpecInt
GParamSpecUInt
GParamSpecLong
GParamSpecULong
GParamSpecEnum
GParamSpecFlags
GParamSpecFloat
GParamSpecDouble
GParamSpecString
GParamSpecObject
g_param_spec_char
g_param_spec_uchar
g_param_spec_boolean
g_param_spec_int
g_param_spec_uint
g_param_spec_long
g_param_spec_ulong
g_param_spec_enum
g_param_spec_flags
g_param_spec_float
g_param_spec_double
g_param_spec_string
g_param_spec_string_c
g_param_spec_object
</SECTION>
<SECTION>
<TITLE>Varargs Value Collection</TITLE>
<FILE>value_collection</FILE>
GTypeCValue
G_VALUE_COLLECT
G_VALUE_LCOPY
</SECTION>
<!-- ##### SECTION Title ##### -->
Asynchronous Queues
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GAsyncQueue ##### -->
<para>
</para>
<!-- ##### FUNCTION g_async_queue_new ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION g_async_queue_lock ##### -->
<para>
</para>
@queue:
<!-- ##### FUNCTION g_async_queue_unlock ##### -->
<para>
</para>
@queue:
<!-- ##### FUNCTION g_async_queue_ref ##### -->
<para>
</para>
@queue:
<!-- ##### FUNCTION g_async_queue_ref_unlocked ##### -->
<para>
</para>
@queue:
<!-- ##### FUNCTION g_async_queue_unref ##### -->
<para>
</para>
@queue:
<!-- ##### FUNCTION g_async_queue_unref_and_unlock ##### -->
<para>
</para>
@queue:
<!-- ##### FUNCTION g_async_queue_push ##### -->
<para>
</para>
@queue:
@data:
<!-- ##### FUNCTION g_async_queue_push_unlocked ##### -->
<para>
</para>
@queue:
@data:
<!-- ##### FUNCTION g_async_queue_pop ##### -->
<para>
</para>
@queue:
@Returns:
<!-- ##### FUNCTION g_async_queue_pop_unlocked ##### -->
<para>
</para>
@queue:
@Returns:
<!-- ##### FUNCTION g_async_queue_try_pop ##### -->
<para>
</para>
@queue:
@Returns:
<!-- ##### FUNCTION g_async_queue_try_pop_unlocked ##### -->
<para>
</para>
@queue:
@Returns:
<!-- ##### FUNCTION g_async_queue_timed_pop ##### -->
<para>
</para>
@queue:
@end_time:
@Returns:
<!-- ##### FUNCTION g_async_queue_timed_pop_unlocked ##### -->
<para>
</para>
@queue:
@end_time:
@Returns:
<!-- ##### FUNCTION g_async_queue_length ##### -->
<para>
</para>
@queue:
@Returns:
<!-- ##### FUNCTION g_async_queue_length_unlocked ##### -->
<para>
</para>
@queue:
@Returns:
<!-- ##### SECTION Title ##### -->
Error Reporting
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GError ##### -->
<para>
</para>
@domain:
@code:
@message:
<!-- ##### FUNCTION g_error_new ##### -->
<para>
</para>
@domain:
@code:
@format:
@Varargs:
@Returns:
<!-- ##### FUNCTION g_error_new_literal ##### -->
<para>
</para>
@domain:
@code:
@message:
@Returns:
<!-- ##### FUNCTION g_error_free ##### -->
<para>
</para>
@error:
<!-- ##### FUNCTION g_error_copy ##### -->
<para>
</para>