Utilize gtkdocize(1) of gtk-doc-1.1.

diff --git a/autogen.pl b/autogen.pl
index c3e0edb..a3269ad 100755 (executable)
--- a/autogen.pl
+++ b/autogen.pl
@@ -40,7 +40,8 @@ AutoGen->run(
                                .include_test_all.stamp
                                ./ChangeLog.bak
                                ./doc/*-pod.*
-                               ./doc/apiref/captive.types
+                               ./doc/apiref/gtk-doc.make
+                               ./doc/apiref/gtk-doc.make-captive
                                ./src/client/bug-replay/captive-bug-replay
                                ./src/client/cmdline/captive-cmdline
                                ./src/client/sandbox-server/captive-sandbox-server
@@ -69,6 +70,15 @@ AutoGen->run(
                                # 1.5 for AM_PROG_AS.
                                # 1.6 to prevent weird error wrt 'SANDBOX_IDL_SOURCES':
                                AutoGen->checkcommandversion("automake","1.6");
+
+                               AutoGen::_system "gtkdocize --copy --docdir doc/apiref/";
+                               for my $fname ("doc/apiref/gtk-doc.make") {
+                                       my $gtk_doc_make=AutoGen::_readfile $fname;
+                                       for my $keyword (qw(EXTRA_DIST CLEANFILES)) {
+                                               $gtk_doc_make=~s/^$keyword =/$keyword +=/m or confess "$keyword not found in $fname";
+                                               }
+                                       AutoGen::_writefile "$fname-captive",$gtk_doc_make;
+                                       }
                                1;
                                },
                );

diff --git a/doc/apiref/Makefile.am b/doc/apiref/Makefile.am
index 86afe0c..10fc399 100644 (file)
--- a/doc/apiref/Makefile.am
+++ b/doc/apiref/Makefile.am
@@ -21,31 +21,24 @@ WANT_GTK_DOC=1
 include $(top_srcdir)/Makefile-head.am
 
 
-BUILT_SOURCES+=$(PACKAGE).types
-$(PACKAGE).types:
-       echo >$@
-
-# captive: configuration for $(top_srcdir)/macros/Makefile-gtk-doc.am
+# captive: configuration for gtk-doc.make of gtk-doc
 
 # The name of the module, e.g. 'glib'.
-DOC_MODULE=$(PACKAGE)
+DOC_MODULE=$(PACKAGE)-apiref
 
 # The top-level SGML file. Change it if you want.
-DOC_MAIN_SGML_FILE=$(DOC_MODULE).sgml
+DOC_MAIN_SGML_FILE=$(DOC_MODULE).xml
 
 # The directory containing the source code. Relative to $(srcdir).
 # gtk-doc will search all .c & .h files beneath here for inline comments
 # documenting functions and macros.
 DOC_SOURCE_DIR=$(top_srcdir)/src
 
-# Extra options to pass to gtkdoc-scanobj or gtkdoc-scangobj.
-SCANOBJ_OPTIONS=
-
 # Extra options to supply to gtkdoc-scan.
 SCAN_OPTIONS=
 
 # Extra options to supply to gtkdoc-mkdb.
-MKDB_OPTIONS=
+MKDB_OPTIONS=--sgml-mode --output-format=xml
 
 # Extra options to supply to gtkdoc-fixref.
 FIXXREF_OPTIONS=
@@ -54,32 +47,37 @@ FIXXREF_OPTIONS=
 HFILE_GLOB=
 CFILE_GLOB=
 
-# Header files to ignore when scanning.
+# Header files to ignore when scanning; space-separated list of strings.
 # captive: Ignore $(top_srcdir)/src/libcaptive/include/reactos/
 # captive: Ignore $(top_srcdir)/src/libcaptive/reactos/
-IGNORE_HFILES=reactos
+# captive: Ignore $(top_srcdir)/src/libcaptive/sandbox/sandbox.h
+IGNORE_HFILES=reactos sandbox.h
 
 # Images to copy into HTML directory.
-HTML_IMAGES =
+HTML_IMAGES=
 
 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
-content_files =
-
-# Other files to distribute.
-extra_files =
+content_files=
 
 # CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib
 # contains GtkObjects/GObjects and you want to document signals and properties.
-GTKDOC_CFLAGS =
-GTKDOC_LIBS =
+GTKDOC_CFLAGS=$(GNOME_VFS_MODULE_CFLAGS) $(GLIB_CFLAGS)
+# of $(top_srcdir)/src/libcaptive/Makefile-libcaptive.am
+GTKDOC_CFLAGS+=-DLIBCAPTIVE
+GTKDOC_CFLAGS+=-I$(top_srcdir)/src/libcaptive/reactos/include
+GTKDOC_CFLAGS+=-I$(top_srcdir)/reactos/include -I$(top_srcdir)/reactos/ntoskrnl/include
+GTKDOC_LIBS=$(captive_library)           $(GLIB_LIBS)
+
+
+include gtk-doc.make-captive
+
 
-GTKDOC_CC=$(LIBTOOL) --mode=compile $(CC)
-GTKDOC_LD=$(LIBTOOL) --mode=link $(CC)
+$(DOC_MODULE)-overrides.txt:
+       touch $@
 
-# If you need to override some of the declarations, place them in the
-# $(DOC_MODULE)-overrides.txt file and uncomment the second line here.
-DOC_OVERRIDES =
-#DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt
+$(DOC_MODULE)-sections.txt:
+       touch $@
 
+# Prevent: No rule to make target `tmpl/*.sgml', needed by `sgml-build.stamp'.  Stop.
+tmpl/*.sgml:
 
-include $(top_srcdir)/macros/Makefile-gtk-doc.am

diff --git a/doc/apiref/captive-apiref.types b/doc/apiref/captive-apiref.types
new file mode 100644 (file)
index 0000000..005982b
--- /dev/null
+++ b/doc/apiref/captive-apiref.types
@@ -0,0 +1,16 @@
+#include <glib-object.h>
+#include <captive/client-vfs.h>
+#include <captive/client-directory.h>
+#include <captive/client-file.h>
+#include "../../src/libcaptive/cc/privatebcb.h"
+#include "../../src/libcaptive/cc/privatebcbmap.h"
+#include "../../src/libcaptive/cc/privatebcbpin.h"
+#include "../../src/libcaptive/cc/sharedcachemap.h"
+
+captive_vfs_object_get_type
+captive_directory_object_get_type
+captive_file_object_get_type
+captive_private_bcb_object_get_type
+captive_private_bcb_map_object_get_type
+captive_private_bcb_pin_object_get_type
+captive_shared_cache_map_object_get_type

diff --git a/doc/apiref/captive-apiref.xml b/doc/apiref/captive-apiref.xml
new file mode 100644 (file)
index 0000000..a291402
--- /dev/null
+++ b/doc/apiref/captive-apiref.xml
@@ -0,0 +1,74 @@
+<?xml version="1.0" standalone="no"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
+               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
+<book id="index" xmlns:xi="http://www.w3.org/2001/XInclude">
+  <bookinfo>
+    <title>Operation Captive Reference Manual</title>
+  </bookinfo>
+
+  <chapter>
+    <title>Operation Captive</title>
+    <xi:include href="xml/client-file.xml"/>
+    <xi:include href="xml/client-directory.xml"/>
+    <xi:include href="xml/client-vfs.xml"/>
+    <xi:include href="xml/privatebcb.xml"/>
+    <xi:include href="xml/privatebcbmap.xml"/>
+    <xi:include href="xml/privatebcbpin.xml"/>
+    <xi:include href="xml/sharedcachemap.xml"/>
+    <xi:include href="xml/cmd_mkdir.xml"/>
+    <xi:include href="xml/cmd_shell.xml"/>
+    <xi:include href="xml/main.xml"/>
+    <xi:include href="xml/cmd_quit.xml"/>
+    <xi:include href="xml/cmd_ls.xml"/>
+    <xi:include href="xml/file_info.xml"/>
+    <xi:include href="xml/cmd_rmdir.xml"/>
+    <xi:include href="xml/cmd_help.xml"/>
+    <xi:include href="xml/cmd_cd.xml"/>
+    <xi:include href="xml/cmd_lcd.xml"/>
+    <xi:include href="xml/cmd_put.xml"/>
+    <xi:include href="xml/cmd_rm.xml"/>
+    <xi:include href="xml/cmd_get.xml"/>
+    <xi:include href="xml/cmd_mv.xml"/>
+    <xi:include href="xml/cmd_info.xml"/>
+    <xi:include href="xml/cmd_commit.xml"/>
+    <xi:include href="xml/giognomevfs.xml"/>
+    <xi:include href="xml/gnome-vfs-method.xml"/>
+    <xi:include href="xml/captivefs-attr.xml"/>
+    <xi:include href="xml/lib.xml"/>
+    <xi:include href="xml/result.xml"/>
+    <xi:include href="xml/giochannel-blind.xml"/>
+    <xi:include href="xml/init.xml"/>
+    <xi:include href="xml/ldr.xml"/>
+    <xi:include href="xml/macros.xml"/>
+    <xi:include href="xml/mm.xml"/>
+    <xi:include href="xml/ps_reactos.xml"/>
+    <xi:include href="xml/unicode.xml"/>
+    <xi:include href="xml/unicode_reactos.xml"/>
+    <xi:include href="xml/storage.xml"/>
+    <xi:include href="xml/config2.xml"/>
+    <xi:include href="xml/ldr_exports.xml"/>
+    <xi:include href="xml/calltype_reactos.xml"/>
+    <xi:include href="xml/signal.xml"/>
+    <xi:include href="xml/leave.xml"/>
+    <xi:include href="xml/parent-File.xml"/>
+    <xi:include href="xml/usecount.xml"/>
+    <xi:include href="xml/rtl-file.xml"/>
+    <xi:include href="xml/options.xml"/>
+    <xi:include href="xml/parent-Vfs.xml"/>
+    <xi:include href="xml/parent-Directory.xml"/>
+    <xi:include href="xml/options-module.xml"/>
+    <xi:include href="xml/libxml.xml"/>
+    <xi:include href="xml/media.xml"/>
+    <xi:include href="xml/marshallers.xml"/>
+    <xi:include href="xml/io.xml"/>
+    <xi:include href="xml/sharedcachemap-priv.xml"/>
+    <xi:include href="xml/server-Directory.xml"/>
+    <xi:include href="xml/split.xml"/>
+    <xi:include href="xml/FileInfo.xml"/>
+    <xi:include href="xml/server-Vfs.xml"/>
+    <xi:include href="xml/server-File.xml"/>
+    <xi:include href="xml/client-CaptiveIOChannel.xml"/>
+    <xi:include href="xml/server-GLogFunc.xml"/>
+    <xi:include href="xml/server-CaptiveIOChannel.xml"/>
+  </chapter>
+</book>

diff --git a/doc/apiref/captive.sgml b/doc/apiref/captive.sgml
deleted file mode 100644 (file)
index d5ec280..0000000
--- a/doc/apiref/captive.sgml
+++ /dev/null
@@ -1,15 +0,0 @@
-<!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
-<!ENTITY % captive-doc-top SYSTEM "sgml/captive-doc.top">
-<!ENTITY captive-doc-bottom SYSTEM "sgml/captive-doc.bottom">
-%captive-doc-top;
-]>
-<book id="index">
-  <bookinfo>
-    <title>Operation Captive Reference Manual</title>
-  </bookinfo>
-
-  <chapter>
-    <title>Operation Captive</title>
-    &captive-doc-bottom;
-  </chapter>
-</book>