summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorOwen Taylor <otaylor@redhat.com>2000-09-06 15:01:07 +0000
committerOwen Taylor <otaylor@src.gnome.org>2000-09-06 15:01:07 +0000
commit98dbc6a7108fffb40c077e4727bec3123c132af5 (patch)
treef8147fa557fa202d529d442dae5e987564edb7b3 /docs
parentda765af2bcbcf1718a49cb9634766e4884493f5d (diff)
downloadglib-98dbc6a7108fffb40c077e4727bec3123c132af5.tar.gz
Improve separation of generic non-generic parts and dependencies.
Wed Sep 6 10:59:45 2000 Owen Taylor <otaylor@redhat.com> * gobject/Makefile.am glib/Makefile.am: Improve separation of generic non-generic parts and dependencies.
Diffstat (limited to 'docs')
-rw-r--r--docs/reference/ChangeLog5
-rw-r--r--docs/reference/Makefile.am1
-rw-r--r--docs/reference/glib/.cvsignore2
-rw-r--r--docs/reference/glib/Makefile.am48
-rw-r--r--docs/reference/glib/glib-sections.txt8
-rw-r--r--docs/reference/glib/tmpl/allocators.sgml2
-rw-r--r--docs/reference/glib/tmpl/arrays.sgml2
-rw-r--r--docs/reference/glib/tmpl/arrays_byte.sgml2
-rw-r--r--docs/reference/glib/tmpl/arrays_pointer.sgml2
-rw-r--r--docs/reference/glib/tmpl/async_queues.sgml2
-rw-r--r--docs/reference/glib/tmpl/byte_order.sgml2
-rw-r--r--docs/reference/glib/tmpl/caches.sgml2
-rw-r--r--docs/reference/glib/tmpl/completion.sgml2
-rw-r--r--docs/reference/glib/tmpl/datalist.sgml2
-rw-r--r--docs/reference/glib/tmpl/datasets.sgml2
-rw-r--r--docs/reference/glib/tmpl/date.sgml4
-rw-r--r--docs/reference/glib/tmpl/error_reporting.sgml2
-rw-r--r--docs/reference/glib/tmpl/glib-unused.sgml42
-rw-r--r--docs/reference/glib/tmpl/hash_tables.sgml2
-rw-r--r--docs/reference/glib/tmpl/hooks.sgml2
-rw-r--r--docs/reference/glib/tmpl/iochannels.sgml2
-rw-r--r--docs/reference/glib/tmpl/limits.sgml2
-rw-r--r--docs/reference/glib/tmpl/linked_lists_double.sgml2
-rw-r--r--docs/reference/glib/tmpl/linked_lists_single.sgml2
-rw-r--r--docs/reference/glib/tmpl/macros.sgml2
-rw-r--r--docs/reference/glib/tmpl/macros_misc.sgml44
-rw-r--r--docs/reference/glib/tmpl/main.sgml2
-rw-r--r--docs/reference/glib/tmpl/memory.sgml2
-rw-r--r--docs/reference/glib/tmpl/memory_chunks.sgml2
-rw-r--r--docs/reference/glib/tmpl/messages.sgml2
-rw-r--r--docs/reference/glib/tmpl/misc_utils.sgml2
-rw-r--r--docs/reference/glib/tmpl/modules.sgml2
-rw-r--r--docs/reference/glib/tmpl/numerical.sgml2
-rw-r--r--docs/reference/glib/tmpl/quarks.sgml2
-rw-r--r--docs/reference/glib/tmpl/queue.sgml2
-rw-r--r--docs/reference/glib/tmpl/random_numbers.sgml2
-rw-r--r--docs/reference/glib/tmpl/relations.sgml2
-rw-r--r--docs/reference/glib/tmpl/scanner.sgml2
-rw-r--r--docs/reference/glib/tmpl/string_chunks.sgml2
-rw-r--r--docs/reference/glib/tmpl/string_utils.sgml2
-rw-r--r--docs/reference/glib/tmpl/strings.sgml2
-rw-r--r--docs/reference/glib/tmpl/thread_pools.sgml2
-rw-r--r--docs/reference/glib/tmpl/threads.sgml2
-rw-r--r--docs/reference/glib/tmpl/timers.sgml2
-rw-r--r--docs/reference/glib/tmpl/trash_stack.sgml2
-rw-r--r--docs/reference/glib/tmpl/trees-binary.sgml2
-rw-r--r--docs/reference/glib/tmpl/trees-nary.sgml2
-rw-r--r--docs/reference/glib/tmpl/type_conversion.sgml2
-rw-r--r--docs/reference/glib/tmpl/types.sgml2
-rw-r--r--docs/reference/glib/tmpl/unicode.sgml8
-rw-r--r--docs/reference/glib/tmpl/warnings.sgml2
-rw-r--r--docs/reference/glib/tmpl/windows.sgml2
-rw-r--r--docs/reference/gobject/.cvsignore2
-rw-r--r--docs/reference/gobject/Makefile.am43
-rw-r--r--docs/reference/gobject/gobject-docs.sgml17
-rw-r--r--docs/reference/gobject/gobject-overrides.txt0
-rw-r--r--docs/reference/gobject/tmpl/enumerations_flags.sgml2
-rw-r--r--docs/reference/gobject/tmpl/generic_values.sgml2
-rw-r--r--docs/reference/gobject/tmpl/objects.sgml2
-rw-r--r--docs/reference/gobject/tmpl/param_specs.sgml2
-rw-r--r--docs/reference/gobject/tmpl/standard_params.sgml2
-rw-r--r--docs/reference/gobject/tmpl/types.sgml2
-rw-r--r--docs/reference/gobject/tmpl/value_collection.sgml2
-rw-r--r--docs/reference/gobject/tmpl/value_types.sgml2
64 files changed, 133 insertions, 193 deletions
diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index caf9f48bc..ef8c5495d 100644
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,3 +1,8 @@
+Wed Sep 6 10:59:45 2000 Owen Taylor <otaylor@redhat.com>
+
+ * gobject/Makefile.am glib/Makefile.am: Improve
+ separation of generic non-generic parts and dependencies.
+
Tue Sep 5 20:03:25 2000 Owen Taylor <otaylor@redhat.com>
* Moved into glib source tree, updated glib-sections.txt
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
new file mode 100644
index 000000000..e84e1506b
--- /dev/null
+++ b/docs/reference/Makefile.am
@@ -0,0 +1 @@
+SUBDIRS = glib gobject \ No newline at end of file
diff --git a/docs/reference/glib/.cvsignore b/docs/reference/glib/.cvsignore
index 4a6f0576a..1932b0fb4 100644
--- a/docs/reference/glib/.cvsignore
+++ b/docs/reference/glib/.cvsignore
@@ -1,3 +1,5 @@
+Makefile
+Makefile.in
glib-unused.txt
glib-decl-list.txt
glib-decl.txt
diff --git a/docs/reference/glib/Makefile.am b/docs/reference/glib/Makefile.am
index a18fdef75..bc9b9e95d 100644
--- a/docs/reference/glib/Makefile.am
+++ b/docs/reference/glib/Makefile.am
@@ -6,10 +6,17 @@ DOC_MODULE=glib
# The top-level SGML file.
DOC_MAIN_SGML_FILE=glib-docs.sgml
-# The directory containing the source code (if it contains documentation).
+# The directory containing the source code
DOC_SOURCE_DIR=$(top_srcdir)
-TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)
+# Headers to ignore
+IGNORE_HFILES= \
+ gobject \
+ config.h \
+ gmoduleconf.h \
+ gunidecomp.h \
+ gunichartables.h \
+ glibconfig-sysdefs.h
tmpl_sources = \
tmpl/allocators.sgml \
@@ -60,33 +67,37 @@ tmpl_sources = \
tmpl/warnings.sgml \
tmpl/windows.sgml
-glib_docdir = $(HTML_DIR)
-glib_doc_DATA = \
- glib-sections.txt \
- glib-overrides.txt
+
+####################################
+# Everything below here is generic #
+####################################
+
+TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)
EXTRA_DIST = \
- $(glib_doc_DATA)
+ $(DOC_MAIN_SGML_FILE) \
+ $(DOC_MODULE)-sections.txt \
+ $(DOC_MODULE)-overrides.txt
if ENABLE_GTK_DOC
all-local: html/index.html
-glib-decl.txt:
+$(DOC_MODULE)-decl.txt:
$(MAKE) scan
-$(tmpl_sources): glib-decl.txt glib-sections.txt glib-overrides.txt
+$(tmpl_sources): $(DOC_MODULE)-decl.txt $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt
$(MAKE) templates
-sgml/glib-doc.bottom: $(tmpl_sources) glib-decl.txt
+sgml/$(DOC_MODULE)-doc.bottom: $(tmpl_sources) $(DOC_MODULE)-decl.txt
$(MAKE) sgml
-html/index.html: sgml/glib-doc.bottom
+html/index.html: sgml/$(DOC_MODULE)-doc.bottom $(DOC_MAIN_SGML_FILE)
$(MAKE) html
endif
scan:
-(cd $(srcdir) \
- && gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="gobject config.h gmoduleconf.h gunidecomp.h gunichartables.h glibconfig-sysdefs.h" )
+ && gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="$(IGNORE_HFILES)" )
templates:
cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE)
@@ -121,7 +132,18 @@ install-data-local:
$(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR); \
fi)
-dist-hook:
+#
+# Require gtk-doc when making dist
+#
+if ENABLE_GTK_DOC
+dist-check-gtkdoc:
+else
+dist-check-gtkdoc:
+ @echo "*** gtk-doc must be installed and enabled in order to make dist
+ @false
+endif
+
+dist-hook: dist-check-gtkdoc
mkdir $(distdir)/html
mkdir $(distdir)/sgml
mkdir $(distdir)/tmpl
diff --git a/docs/reference/glib/glib-sections.txt b/docs/reference/glib/glib-sections.txt
index 960b921ac..2c80eafd0 100644
--- a/docs/reference/glib/glib-sections.txt
+++ b/docs/reference/glib/glib-sections.txt
@@ -272,12 +272,6 @@ G_GNUC_PRETTY_FUNCTION
G_STRLOC
<SUBSECTION>
-G_GSHORT_FORMAT
-G_GUSHORT_FORMAT
-G_GINT_FORMAT
-G_GUINT_FORMAT
-G_GLONG_FORMAT
-G_GULONG_FORMAT
G_GINT16_FORMAT
G_GUINT16_FORMAT
G_GINT32_FORMAT
@@ -711,7 +705,7 @@ g_strsignal
<SECTION>
<TITLE>Date and Time Functions</TITLE>
<FILE>date</FILE>
-G_MICROSEC
+G_USEC_PER_SEC
GTimeVal
g_get_current_time
g_usleep
diff --git a/docs/reference/glib/tmpl/allocators.sgml b/docs/reference/glib/tmpl/allocators.sgml
index cf354ddc2..7b8807eec 100644
--- a/docs/reference/glib/tmpl/allocators.sgml
+++ b/docs/reference/glib/tmpl/allocators.sgml
@@ -9,13 +9,11 @@ Memory Allocators
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### STRUCT GAllocator ##### -->
<para>
diff --git a/docs/reference/glib/tmpl/arrays.sgml b/docs/reference/glib/tmpl/arrays.sgml
index f40e49ed1..bae144152 100644
--- a/docs/reference/glib/tmpl/arrays.sgml
+++ b/docs/reference/glib/tmpl/arrays.sgml
@@ -9,13 +9,11 @@ Arrays
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### STRUCT GArray ##### -->
<para>
diff --git a/docs/reference/glib/tmpl/arrays_byte.sgml b/docs/reference/glib/tmpl/arrays_byte.sgml
index c5d5da2ff..acdb74550 100644
--- a/docs/reference/glib/tmpl/arrays_byte.sgml
+++ b/docs/reference/glib/tmpl/arrays_byte.sgml
@@ -9,13 +9,11 @@ Byte Arrays
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### STRUCT GByteArray ##### -->
<para>
diff --git a/docs/reference/glib/tmpl/arrays_pointer.sgml b/docs/reference/glib/tmpl/arrays_pointer.sgml
index 21d7287d5..c969f2eb0 100644
--- a/docs/reference/glib/tmpl/arrays_pointer.sgml
+++ b/docs/reference/glib/tmpl/arrays_pointer.sgml
@@ -9,13 +9,11 @@ Pointer Arrays
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### STRUCT GPtrArray ##### -->
<para>
diff --git a/docs/reference/glib/tmpl/async_queues.sgml b/docs/reference/glib/tmpl/async_queues.sgml
index 97a0f41ac..3065103d0 100644
--- a/docs/reference/glib/tmpl/async_queues.sgml
+++ b/docs/reference/glib/tmpl/async_queues.sgml
@@ -9,13 +9,11 @@ Asynchronous Queues
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### STRUCT GAsyncQueue ##### -->
<para>
diff --git a/docs/reference/glib/tmpl/byte_order.sgml b/docs/reference/glib/tmpl/byte_order.sgml
index 87b455a7b..acd833757 100644
--- a/docs/reference/glib/tmpl/byte_order.sgml
+++ b/docs/reference/glib/tmpl/byte_order.sgml
@@ -9,13 +9,11 @@ Byte Order Macros
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### MACRO G_BYTE_ORDER ##### -->
<para>
diff --git a/docs/reference/glib/tmpl/caches.sgml b/docs/reference/glib/tmpl/caches.sgml
index 1355726fb..ee51d1f7b 100644
--- a/docs/reference/glib/tmpl/caches.sgml
+++ b/docs/reference/glib/tmpl/caches.sgml
@@ -9,13 +9,11 @@ Caches
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### STRUCT GCache ##### -->
<para>
diff --git a/docs/reference/glib/tmpl/completion.sgml b/docs/reference/glib/tmpl/completion.sgml
index adba6c3cf..33b8ba99c 100644
--- a/docs/reference/glib/tmpl/completion.sgml
+++ b/docs/reference/glib/tmpl/completion.sgml
@@ -9,13 +9,11 @@ Automatic String Completion
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### STRUCT GCompletion ##### -->
<para>
diff --git a/docs/reference/glib/tmpl/datalist.sgml b/docs/reference/glib/tmpl/datalist.sgml
index 33df5a353..ef17f99f1 100644
--- a/docs/reference/glib/tmpl/datalist.sgml
+++ b/docs/reference/glib/tmpl/datalist.sgml
@@ -9,13 +9,11 @@ Keyed Data Lists
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### STRUCT GData ##### -->
<para>
diff --git a/docs/reference/glib/tmpl/datasets.sgml b/docs/reference/glib/tmpl/datasets.sgml
index f935397b2..b1105253b 100644
--- a/docs/reference/glib/tmpl/datasets.sgml
+++ b/docs/reference/glib/tmpl/datasets.sgml
@@ -9,13 +9,11 @@ Datasets
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### MACRO g_dataset_id_set_data ##### -->
<para>
diff --git a/docs/reference/glib/tmpl/date.sgml b/docs/reference/glib/tmpl/date.sgml
index 8ed97ce51..f929872be 100644
--- a/docs/reference/glib/tmpl/date.sgml
+++ b/docs/reference/glib/tmpl/date.sgml
@@ -9,14 +9,12 @@ Date and Time Functions
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
-<!-- ##### MACRO G_MICROSEC ##### -->
+<!-- ##### MACRO G_USEC_PER_SEC ##### -->
<para>
</para>
diff --git a/docs/reference/glib/tmpl/error_reporting.sgml b/docs/reference/glib/tmpl/error_reporting.sgml
index 7bcc55904..132d20077 100644
--- a/docs/reference/glib/tmpl/error_reporting.sgml
+++ b/docs/reference/glib/tmpl/error_reporting.sgml
@@ -9,13 +9,11 @@ Error Reporting
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### STRUCT GError ##### -->
<para>
diff --git a/docs/reference/glib/tmpl/glib-unused.sgml b/docs/reference/glib/tmpl/glib-unused.sgml
index e69de29bb..380562c2c 100644
--- a/docs/reference/glib/tmpl/glib-unused.sgml
+++ b/docs/reference/glib/tmpl/glib-unused.sgml
@@ -0,0 +1,42 @@
+<!-- ##### MACRO G_GLONG_FORMAT ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### MACRO G_GSHORT_FORMAT ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### MACRO G_GUSHORT_FORMAT ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### MACRO G_GINT_FORMAT ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### MACRO G_GUINT_FORMAT ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### MACRO G_GULONG_FORMAT ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### MACRO G_MICROSEC ##### -->
+<para>
+
+</para>
+
+
diff --git a/docs/reference/glib/tmpl/hash_tables.sgml b/docs/reference/glib/tmpl/hash_tables.sgml
index 8c0577826..4846b7b96 100644
--- a/docs/reference/glib/tmpl/hash_tables.sgml
+++ b/docs/reference/glib/tmpl/hash_tables.sgml
@@ -9,13 +9,11 @@ Hash Tables
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### STRUCT GHashTable ##### -->
<para>
diff --git a/docs/reference/glib/tmpl/hooks.sgml b/docs/reference/glib/tmpl/hooks.sgml
index bd74101c9..fecd43c49 100644
--- a/docs/reference/glib/tmpl/hooks.sgml
+++ b/docs/reference/glib/tmpl/hooks.sgml
@@ -9,13 +9,11 @@ Hook Functions
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### STRUCT GHookList ##### -->
<para>
diff --git a/docs/reference/glib/tmpl/iochannels.sgml b/docs/reference/glib/tmpl/iochannels.sgml
index a9365443c..fcdbeef72 100644
--- a/docs/reference/glib/tmpl/iochannels.sgml
+++ b/docs/reference/glib/tmpl/iochannels.sgml
@@ -9,13 +9,11 @@ IO Channels
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### STRUCT GIOChannel ##### -->
<para>
diff --git a/docs/reference/glib/tmpl/limits.sgml b/docs/reference/glib/tmpl/limits.sgml
index 57a65293c..1e73eb045 100644
--- a/docs/reference/glib/tmpl/limits.sgml
+++ b/docs/reference/glib/tmpl/limits.sgml
@@ -9,13 +9,11 @@ Limits of Basic Types
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### MACRO G_MININT ##### -->
<para>
diff --git a/docs/reference/glib/tmpl/linked_lists_double.sgml b/docs/reference/glib/tmpl/linked_lists_double.sgml
index 1b3a9188f..7e907188d 100644
--- a/docs/reference/glib/tmpl/linked_lists_double.sgml
+++ b/docs/reference/glib/tmpl/linked_lists_double.sgml
@@ -9,13 +9,11 @@ Doubly-Linked Lists
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### STRUCT GList ##### -->
<para>
diff --git a/docs/reference/glib/tmpl/linked_lists_single.sgml b/docs/reference/glib/tmpl/linked_lists_single.sgml
index 6467f7e38..dbab524bc 100644
--- a/docs/reference/glib/tmpl/linked_lists_single.sgml
+++ b/docs/reference/glib/tmpl/linked_lists_single.sgml
@@ -9,13 +9,11 @@ Singly-Linked Lists
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### STRUCT GSList ##### -->
<para>
diff --git a/docs/reference/glib/tmpl/macros.sgml b/docs/reference/glib/tmpl/macros.sgml
index bf09e3488..c2a4c2fd1 100644
--- a/docs/reference/glib/tmpl/macros.sgml
+++ b/docs/reference/glib/tmpl/macros.sgml
@@ -9,13 +9,11 @@ Standard Macros
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### MACRO GLIB_MAJOR_VERSION ##### -->
<para>
diff --git a/docs/reference/glib/tmpl/macros_misc.sgml b/docs/reference/glib/tmpl/macros_misc.sgml
index ba10972db..43e4b8b93 100644
--- a/docs/reference/glib/tmpl/macros_misc.sgml
+++ b/docs/reference/glib/tmpl/macros_misc.sgml
@@ -9,13 +9,11 @@ Miscellaneous Macros
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### MACRO G_INLINE_FUNC ##### -->
<para>
@@ -137,48 +135,6 @@ Miscellaneous Macros
-<!-- ##### MACRO G_GSHORT_FORMAT ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO G_GUSHORT_FORMAT ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO G_GINT_FORMAT ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO G_GUINT_FORMAT ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO G_GLONG_FORMAT ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO G_GULONG_FORMAT ##### -->
-<para>
-
-</para>
-
-
-
<!-- ##### MACRO G_GINT16_FORMAT ##### -->
<para>
diff --git a/docs/reference/glib/tmpl/main.sgml b/docs/reference/glib/tmpl/main.sgml
index 7c12f1e8c..212f500ee 100644
--- a/docs/reference/glib/tmpl/main.sgml
+++ b/docs/reference/glib/tmpl/main.sgml
@@ -9,13 +9,11 @@ The Main Event Loop
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### STRUCT GMainLoop ##### -->
<para>
diff --git a/docs/reference/glib/tmpl/memory.sgml b/docs/reference/glib/tmpl/memory.sgml
index c1f236d4e..e940bca38 100644
--- a/docs/reference/glib/tmpl/memory.sgml
+++ b/docs/reference/glib/tmpl/memory.sgml
@@ -9,13 +9,11 @@ Memory Allocation
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### MACRO g_new ##### -->
<para>
diff --git a/docs/reference/glib/tmpl/memory_chunks.sgml b/docs/reference/glib/tmpl/memory_chunks.sgml
index 3f2f596d6..17601e611 100644
--- a/docs/reference/glib/tmpl/memory_chunks.sgml
+++ b/docs/reference/glib/tmpl/memory_chunks.sgml
@@ -9,13 +9,11 @@ Memory Chunks
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### STRUCT GMemChunk ##### -->
<para>
diff --git a/docs/reference/glib/tmpl/messages.sgml b/docs/reference/glib/tmpl/messages.sgml
index 7d94f128f..d563744f9 100644
--- a/docs/reference/glib/tmpl/messages.sgml
+++ b/docs/reference/glib/tmpl/messages.sgml
@@ -9,13 +9,11 @@ Message Logging
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### MACRO G_LOG_DOMAIN ##### -->
<para>
diff --git a/docs/reference/glib/tmpl/misc_utils.sgml b/docs/reference/glib/tmpl/misc_utils.sgml
index 5576e1a5d..932d4a2c8 100644
--- a/docs/reference/glib/tmpl/misc_utils.sgml
+++ b/docs/reference/glib/tmpl/misc_utils.sgml
@@ -9,13 +9,11 @@ Miscellaneous Utility Functions
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### FUNCTION g_get_prgname ##### -->
<para>
diff --git a/docs/reference/glib/tmpl/modules.sgml b/docs/reference/glib/tmpl/modules.sgml
index ec1f92a23..3a6410dba 100644
--- a/docs/reference/glib/tmpl/modules.sgml
+++ b/docs/reference/glib/tmpl/modules.sgml
@@ -9,13 +9,11 @@ Dynamic Loading of Modules
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### STRUCT GModule ##### -->
<para>
diff --git a/docs/reference/glib/tmpl/numerical.sgml b/docs/reference/glib/tmpl/numerical.sgml
index 4600f572d..aa902d3d9 100644
--- a/docs/reference/glib/tmpl/numerical.sgml
+++ b/docs/reference/glib/tmpl/numerical.sgml
@@ -9,13 +9,11 @@ Numerical Definitions
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### MACRO G_IEEE754_FLOAT_BIAS ##### -->
<para>
diff --git a/docs/reference/glib/tmpl/quarks.sgml b/docs/reference/glib/tmpl/quarks.sgml
index 997e336a6..d6644a0ba 100644
--- a/docs/reference/glib/tmpl/quarks.sgml
+++ b/docs/reference/glib/tmpl/quarks.sgml
@@ -9,13 +9,11 @@ Quarks
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### TYPEDEF GQuark ##### -->
<para>
diff --git a/docs/reference/glib/tmpl/queue.sgml b/docs/reference/glib/tmpl/queue.sgml
index 72d95f2ce..c178f27fd 100644
--- a/docs/reference/glib/tmpl/queue.sgml
+++ b/docs/reference/glib/tmpl/queue.sgml
@@ -9,13 +9,11 @@ Double-ended Queues
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### STRUCT GQueue ##### -->
<para>
diff --git a/docs/reference/glib/tmpl/random_numbers.sgml b/docs/reference/glib/tmpl/random_numbers.sgml
index 233538fb1..037992c06 100644
--- a/docs/reference/glib/tmpl/random_numbers.sgml
+++ b/docs/reference/glib/tmpl/random_numbers.sgml
@@ -9,13 +9,11 @@ Random Numbers
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### STRUCT GRand ##### -->
<para>
diff --git a/docs/reference/glib/tmpl/relations.sgml b/docs/reference/glib/tmpl/relations.sgml
index 7bf216f54..9a7a8608a 100644
--- a/docs/reference/glib/tmpl/relations.sgml
+++ b/docs/reference/glib/tmpl/relations.sgml
@@ -9,13 +9,11 @@ Relations and Tuples
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### STRUCT GRelation ##### -->
<para>
diff --git a/docs/reference/glib/tmpl/scanner.sgml b/docs/reference/glib/tmpl/scanner.sgml
index 0b42f475a..496a9416e 100644
--- a/docs/reference/glib/tmpl/scanner.sgml
+++ b/docs/reference/glib/tmpl/scanner.sgml
@@ -9,13 +9,11 @@ Lexical Scanner
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### STRUCT GScanner ##### -->
<para>
diff --git a/docs/reference/glib/tmpl/string_chunks.sgml b/docs/reference/glib/tmpl/string_chunks.sgml
index de2462828..43a3364cd 100644
--- a/docs/reference/glib/tmpl/string_chunks.sgml
+++ b/docs/reference/glib/tmpl/string_chunks.sgml
@@ -9,13 +9,11 @@ String Chunks
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### STRUCT GStringChunk ##### -->
<para>
diff --git a/docs/reference/glib/tmpl/string_utils.sgml b/docs/reference/glib/tmpl/string_utils.sgml
index 2da378827..655f62fdc 100644
--- a/docs/reference/glib/tmpl/string_utils.sgml
+++ b/docs/reference/glib/tmpl/string_utils.sgml
@@ -9,13 +9,11 @@ String Utility Functions
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### FUNCTION g_strdup ##### -->
<para>
diff --git a/docs/reference/glib/tmpl/strings.sgml b/docs/reference/glib/tmpl/strings.sgml
index c9167c23e..ff7859d7c 100644
--- a/docs/reference/glib/tmpl/strings.sgml
+++ b/docs/reference/glib/tmpl/strings.sgml
@@ -9,13 +9,11 @@ Strings
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### STRUCT GString ##### -->
<para>
diff --git a/docs/reference/glib/tmpl/thread_pools.sgml b/docs/reference/glib/tmpl/thread_pools.sgml
index fb1454b66..5d4d0dd73 100644
--- a/docs/reference/glib/tmpl/thread_pools.sgml
+++ b/docs/reference/glib/tmpl/thread_pools.sgml
@@ -9,13 +9,11 @@ Thread Pools
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### STRUCT GThreadPool ##### -->
<para>
diff --git a/docs/reference/glib/tmpl/threads.sgml b/docs/reference/glib/tmpl/threads.sgml
index dc1c24561..546eed447 100644
--- a/docs/reference/glib/tmpl/threads.sgml
+++ b/docs/reference/glib/tmpl/threads.sgml
@@ -9,13 +9,11 @@ Threads
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### MACRO G_THREADS_ENABLED ##### -->
<para>
diff --git a/docs/reference/glib/tmpl/timers.sgml b/docs/reference/glib/tmpl/timers.sgml
index 621998dc7..0a05d6cc8 100644
--- a/docs/reference/glib/tmpl/timers.sgml
+++ b/docs/reference/glib/tmpl/timers.sgml
@@ -9,13 +9,11 @@ Timers
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### STRUCT GTimer ##### -->
<para>
diff --git a/docs/reference/glib/tmpl/trash_stack.sgml b/docs/reference/glib/tmpl/trash_stack.sgml
index 875d21963..2d28613d7 100644
--- a/docs/reference/glib/tmpl/trash_stack.sgml
+++ b/docs/reference/glib/tmpl/trash_stack.sgml
@@ -9,13 +9,11 @@ Trash Stacks
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### STRUCT GTrashStack ##### -->
<para>
diff --git a/docs/reference/glib/tmpl/trees-binary.sgml b/docs/reference/glib/tmpl/trees-binary.sgml
index 2e9e50fc0..c19ab9342 100644
--- a/docs/reference/glib/tmpl/trees-binary.sgml
+++ b/docs/reference/glib/tmpl/trees-binary.sgml
@@ -9,13 +9,11 @@ Balanced Binary Trees
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### STRUCT GTree ##### -->
<para>
diff --git a/docs/reference/glib/tmpl/trees-nary.sgml b/docs/reference/glib/tmpl/trees-nary.sgml
index a7589e1af..c994ac61c 100644
--- a/docs/reference/glib/tmpl/trees-nary.sgml
+++ b/docs/reference/glib/tmpl/trees-nary.sgml
@@ -9,13 +9,11 @@ N-ary Trees
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### STRUCT GNode ##### -->
<para>
diff --git a/docs/reference/glib/tmpl/type_conversion.sgml b/docs/reference/glib/tmpl/type_conversion.sgml
index d63aee644..dd4adec70 100644
--- a/docs/reference/glib/tmpl/type_conversion.sgml
+++ b/docs/reference/glib/tmpl/type_conversion.sgml
@@ -9,13 +9,11 @@ Type Conversion Macros
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### MACRO GINT_TO_POINTER ##### -->
<para>
diff --git a/docs/reference/glib/tmpl/types.sgml b/docs/reference/glib/tmpl/types.sgml
index e64242ec7..92f5b5471 100644
--- a/docs/reference/glib/tmpl/types.sgml
+++ b/docs/reference/glib/tmpl/types.sgml
@@ -9,13 +9,11 @@ Basic Types
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### TYPEDEF gboolean ##### -->
<para>
diff --git a/docs/reference/glib/tmpl/unicode.sgml b/docs/reference/glib/tmpl/unicode.sgml
index db8cc03ee..413cc89eb 100644
--- a/docs/reference/glib/tmpl/unicode.sgml
+++ b/docs/reference/glib/tmpl/unicode.sgml
@@ -9,13 +9,11 @@ Unicode Manipulation
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### TYPEDEF gunichar ##### -->
<para>
@@ -326,6 +324,8 @@ Unicode Manipulation
@p:
@end:
@Returns:
+<!-- # Unused Parameters # -->
+@bound:
<!-- ##### FUNCTION g_utf8_find_prev_char ##### -->
@@ -367,6 +367,8 @@ Unicode Manipulation
@p:
@c:
@Returns:
+<!-- # Unused Parameters # -->
+@ch:
<!-- ##### FUNCTION g_utf8_strrchr ##### -->
@@ -377,6 +379,8 @@ Unicode Manipulation
@p:
@c:
@Returns:
+<!-- # Unused Parameters # -->
+@ch:
<!-- ##### FUNCTION g_utf8_to_utf16 ##### -->
diff --git a/docs/reference/glib/tmpl/warnings.sgml b/docs/reference/glib/tmpl/warnings.sgml
index ca360571e..451d3290d 100644
--- a/docs/reference/glib/tmpl/warnings.sgml
+++ b/docs/reference/glib/tmpl/warnings.sgml
@@ -9,13 +9,11 @@ Warnings and Assertions
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### FUNCTION g_print ##### -->
<para>
diff --git a/docs/reference/glib/tmpl/windows.sgml b/docs/reference/glib/tmpl/windows.sgml
index 16d841a9b..e07c6a839 100644
--- a/docs/reference/glib/tmpl/windows.sgml
+++ b/docs/reference/glib/tmpl/windows.sgml
@@ -9,13 +9,11 @@ Windows Compatability Functions
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### MACRO MAXPATHLEN ##### -->
<para>
diff --git a/docs/reference/gobject/.cvsignore b/docs/reference/gobject/.cvsignore
index 8702e770e..8136b3153 100644
--- a/docs/reference/gobject/.cvsignore
+++ b/docs/reference/gobject/.cvsignore
@@ -1,3 +1,5 @@
+Makefile
+Makefile.in
gobject-decl.txt
gobject-unused.txt
gobject-decl-list.txt
diff --git a/docs/reference/gobject/Makefile.am b/docs/reference/gobject/Makefile.am
index 451cdad66..532774d23 100644
--- a/docs/reference/gobject/Makefile.am
+++ b/docs/reference/gobject/Makefile.am
@@ -9,7 +9,8 @@ DOC_MAIN_SGML_FILE=gobject-docs.sgml
# The directory containing the source code (if it contains documentation).
DOC_SOURCE_DIR=$(top_srcdir)/gobject
-TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)
+# Headers to ignore
+IGNORE_HFILES=
tmpl_sources = \
tmpl/enumerations_flags.sgml \
@@ -22,35 +23,38 @@ tmpl_sources = \
tmpl/value_collection.sgml \
tmpl/value_types.sgml
-gobject_docdir = $(HTML_DIR)
-gobject_doc_DATA = \
- gobject-sections.txt
+####################################
+# Everything below here is generic #
+####################################
+TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)
EXTRA_DIST = \
- $(gobject_doc_DATA)
+ $(DOC_MAIN_SGML_FILE) \
+ $(DOC_MODULE)-sections.txt \
+ $(DOC_MODULE)-overrides.txt
if ENABLE_GTK_DOC
all-local: html/index.html
-gobject-decl.txt:
+$(DOC_MODULE)-decl.txt:
$(MAKE) scan
-$(tmpl_sources): gobject-decl.txt gobject-sections.txt
+$(tmpl_sources): $(DOC_MODULE)-decl.txt $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt
$(MAKE) templates
-sgml/gobject-doc.bottom: $(tmpl_sources) gobject-decl.txt
+sgml/$(DOC_MODULE)-doc.bottom: $(tmpl_sources) $(DOC_MODULE)-decl.txt
$(MAKE) sgml
-html/index.html: sgml/gobject-doc.bottom
+html/index.html: sgml/$(DOC_MODULE)-doc.bottom $(DOC_MAIN_SGML_FILE)
$(MAKE) html
endif
scan:
-(cd $(srcdir) \
- && gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) )
+ && gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="$(IGNORE_HFILES)" )
-templates:
+templates:
cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE)
sgml:
@@ -60,8 +64,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) --extra-dir=$(srcdir)/../glib/html
+ @echo '-- Fixing Crossreferences'
+ gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR)
clean-local:
rm -f *~ *.bak *.signals *-unused.txt
@@ -83,7 +87,18 @@ install-data-local:
$(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR); \
fi)
-dist-hook:
+#
+# Require gtk-doc when making dist
+#
+if ENABLE_GTK_DOC
+dist-check-gtkdoc:
+else
+dist-check-gtkdoc:
+ @echo "*** gtk-doc must be installed and enabled in order to make dist
+ @false
+endif
+
+dist-hook: dist-check-gtkdoc
mkdir $(distdir)/html
mkdir $(distdir)/sgml
mkdir $(distdir)/tmpl
diff --git a/docs/reference/gobject/gobject-docs.sgml b/docs/reference/gobject/gobject-docs.sgml
index bd337060b..c8a907d31 100644
--- a/docs/reference/gobject/gobject-docs.sgml
+++ b/docs/reference/gobject/gobject-docs.sgml
@@ -16,13 +16,14 @@
<reference>
<title>API Reference</title>
- &gobject-types;
- &gobject-objects;
- &gobject-enumerations-flags;
- &gobject-generic-values;
- &gobject-value-types;
- &gobject-value-collection;
- &gobject-param-specs;
- &gobject-standard-params;
+ &gobject-types;
+ &gobject-objects;
+ &gobject-enumerations-flags;
+ &gobject-generic-values;
+ &gobject-value-types;
+ &gobject-value-collection;
+ &gobject-param-specs;
+ &gobject-standard-params;
+ </reference>
</book> \ No newline at end of file
diff --git a/docs/reference/gobject/gobject-overrides.txt b/docs/reference/gobject/gobject-overrides.txt
new file mode 100644
index 000000000..e69de29bb
--- /dev/null
+++ b/docs/reference/gobject/gobject-overrides.txt
diff --git a/docs/reference/gobject/tmpl/enumerations_flags.sgml b/docs/reference/gobject/tmpl/enumerations_flags.sgml
index 0c03fc619..971195e5d 100644
--- a/docs/reference/gobject/tmpl/enumerations_flags.sgml
+++ b/docs/reference/gobject/tmpl/enumerations_flags.sgml
@@ -9,13 +9,11 @@ Enumeration and Flag Types
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### STRUCT GEnumClass ##### -->
<para>
diff --git a/docs/reference/gobject/tmpl/generic_values.sgml b/docs/reference/gobject/tmpl/generic_values.sgml
index 18f2a2f03..af4cbe6c2 100644
--- a/docs/reference/gobject/tmpl/generic_values.sgml
+++ b/docs/reference/gobject/tmpl/generic_values.sgml
@@ -9,13 +9,11 @@ Generic values
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### MACRO G_VALUE_TYPE ##### -->
<para>
diff --git a/docs/reference/gobject/tmpl/objects.sgml b/docs/reference/gobject/tmpl/objects.sgml
index ee2a7d21a..a82953c80 100644
--- a/docs/reference/gobject/tmpl/objects.sgml
+++ b/docs/reference/gobject/tmpl/objects.sgml
@@ -9,13 +9,11 @@ The Base Object Type
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### STRUCT GObject ##### -->
<para>
diff --git a/docs/reference/gobject/tmpl/param_specs.sgml b/docs/reference/gobject/tmpl/param_specs.sgml
index 7ce7b0922..2401f5e99 100644
--- a/docs/reference/gobject/tmpl/param_specs.sgml
+++ b/docs/reference/gobject/tmpl/param_specs.sgml
@@ -9,13 +9,11 @@ Object Parameter Specifications
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### STRUCT GParamSpec ##### -->
<para>
diff --git a/docs/reference/gobject/tmpl/standard_params.sgml b/docs/reference/gobject/tmpl/standard_params.sgml
index 5d297355f..763d4473b 100644
--- a/docs/reference/gobject/tmpl/standard_params.sgml
+++ b/docs/reference/gobject/tmpl/standard_params.sgml
@@ -9,13 +9,11 @@ Standard Parameter Types
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### MACRO G_IS_PARAM_SPEC_CHAR ##### -->
<para>
diff --git a/docs/reference/gobject/tmpl/types.sgml b/docs/reference/gobject/tmpl/types.sgml
index dce9f4da5..a42851cf1 100644
--- a/docs/reference/gobject/tmpl/types.sgml
+++ b/docs/reference/gobject/tmpl/types.sgml
@@ -9,13 +9,11 @@ GType
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### TYPEDEF GType ##### -->
<para>
diff --git a/docs/reference/gobject/tmpl/value_collection.sgml b/docs/reference/gobject/tmpl/value_collection.sgml
index 2066012ba..dfb502d22 100644
--- a/docs/reference/gobject/tmpl/value_collection.sgml
+++ b/docs/reference/gobject/tmpl/value_collection.sgml
@@ -9,13 +9,11 @@ Varargs Value Collection
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### UNION GTypeCValue ##### -->
<para>
diff --git a/docs/reference/gobject/tmpl/value_types.sgml b/docs/reference/gobject/tmpl/value_types.sgml
index 86bca6c1f..e8b37f3bd 100644
--- a/docs/reference/gobject/tmpl/value_types.sgml
+++ b/docs/reference/gobject/tmpl/value_types.sgml
@@ -9,13 +9,11 @@ Standard value types
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### MACRO G_IS_VALUE_CHAR ##### -->
<para>