Rewrite, GTK-DOC from CVS (plus patches) seem to work reasonably well now.

1 files changed, 98 insertions, 78 deletions

diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am
index e9701b6d32..d9238734fc 100644
--- a/doc/reference/Makefile.am
+++ b/doc/reference/Makefile.am
@@ -1,79 +1,99 @@
 ## Process this file with automake to produce Makefile.in
-# Copyright (C) 2003, 2004 Simon Josefsson.
-#
-# This file is part of GNU TLS.
-#
-# GNU TLS is free software; you can redistribute it and/or modify
-# it under the terms of the GNU Lesser General Public License as
-# published by the Free Software Foundation; either version 2.1 of
-# the License, or (at your option) any later version.
-#
-# GNU TLS is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Lesser General Public License for more details.
-#
-# You should have received a copy of the GNU Lesser General Public
-# License along with GNU TLS; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
-
-HIGNORE = auth_anon.h auth_cert.h auth_dh_common.h auth_srp.h		\
-	auth_srp_passwd.h debug.h defines.h ext_cert_type.h		\
-	ext_max_record.h ext_server_name.h ext_srp.h gnutls_alert.h	\
-	gnutls_algorithms.h gnutls_auth.h gnutls_auth_int.h		\
-	gnutls_buffer.h gnutls_buffers.h gnutls_cert.h gnutls_cipher.h	\
-	gnutls_cipher_int.h gnutls_compress.h gnutls_compress_int.h	\
-	gnutls_constate.h gnutls_datum.h gnutls_db.h gnutls_dh.h	\
-	gnutls_errors.h gnutls_errors_int.h gnutls_extensions.h		\
-	gnutls_global.h gnutls_handshake.h gnutls_hash_int.h		\
-	gnutls_int.h gnutls_kx.h gnutls_mem.h gnutls_mpi.h		\
-	gnutls_num.h gnutls_pk.h gnutls_priority.h gnutls_random.h	\
-	gnutls_record.h gnutls_rsa_export.h gnutls_session.h		\
-	gnutls_session_pack.h gnutls_sig.h gnutls_srp.h gnutls_state.h	\
-	gnutls_str.h gnutls_ui.h gnutls_v2_compat.h gnutls_x509.h	\
-	io_debug.h strfile.h x509_b64.h memmem.h \
-	common.h compat.h crq.h dn.h dsa.h extensions.h mpi.h pkcs7.h privkey.h rfc2818.h sign.h verify.h \
-	gnutls_extra.h lzoconf.h minilzo.h openssl_compat.h \
-	gnutls_openpgp.h openpgp.h
-
-HTML_OBJECTS = index.html c4.html gnutls-gnutls.html gnutls-extra.html \
-	gnutls-x509.html gnutls-pkcs12.html \
-	gnutls-openssl.html
-
-EXTRA_DIST = $(PACKAGE)-docs.tmpl $(HTML_OBJECTS) $(IMAGES)
-IMAGES = home.png left.png right.png up.png
-
-all: index.html
-
-scan.stamp: $(top_builddir)/includes/gnutls/*.h $(top_srcdir)/lib/*.c $(top_srcdir)/lib/x509/*.c $(top_srcdir)/libextra/*.c $(top_srcdir)/libextra/openpgp/*.c
-	gtkdoc-scan --module=$(PACKAGE) \
-		--source-dir=$(top_builddir)/includes/gnutls \
-		--source-dir=$(top_srcdir)/lib \
-		--source-dir=$(top_srcdir)/lib/x509 \
-		--source-dir=$(top_srcdir)/libextra \
-		--source-dir=$(top_srcdir)/libextra/openpgp \
-		--ignore-headers="$(HIGNORE)" && touch scan.stamp
-
-tmpl.stamp: scan.stamp
-	gtkdoc-mktmpl --module=$(PACKAGE) --output-dir=.
-
-sgml.stamp: tmpl.stamp
-	gtkdoc-mkdb --module=$(PACKAGE) \
-		--source-dir=$(top_builddir)/includes/gnutls \
-		--source-dir=$(top_srcdir)/lib \
-		--source-dir=$(top_srcdir)/lib/x509 \
-		--source-dir=$(top_srcdir)/libextra \
-		--source-dir=$(top_srcdir)/libextra/openpgp \
-		--tmpl-dir=. --output-dir=. \
-		--main-sgml-file=$(srcdir)/$(PACKAGE)-docs.tmpl
-
-index.html: sgml.stamp
-	cp $(srcdir)/$(PACKAGE)-docs.tmpl $(PACKAGE)-docs.sgml
-	gtkdoc-mkhtml $(PACKAGE) $(PACKAGE)-docs.sgml
-	rm -f $(PACKAGE)-docs.sgml ../html.stamp
-	gtkdoc-fixxref --module-dir=. --html-dir=$(HTML_DIR)
-
-clean-local:
-	rm -f *.bak scan.stamp tmpl.stamp sgml.stamp *.txt *.sgml \
-		$(PACKAGE)-doc.bottom $(PACKAGE)-doc.top \
-		$(HTML_OBJECTS) $(IMAGES) style.css
+
+# We require automake 1.6 at least.
+AUTOMAKE_OPTIONS = 1.6
+
+# This is a blank Makefile.am for using gtk-doc.
+# Copy this to your project's API docs directory and modify the variables to
+# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
+# of using the various options.
+
+# The name of the module, e.g. 'glib'.
+DOC_MODULE=gnutls
+
+# The top-level SGML file. You can change this if you want to.
+DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
+
+# The directory containing the source code. Relative to $(srcdir).
+# gtk-doc will search all .c & .h files beneath here for inline comments
+# documenting the functions and macros.
+# e.g. DOC_SOURCE_DIR=../../../gtk
+DOC_SOURCE_DIR=../../lib
+
+# Extra options to pass to gtkdoc-scangobj. Not normally needed.
+SCANGOBJ_OPTIONS=
+
+# Extra options to supply to gtkdoc-scan.
+# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED" 
+SCAN_OPTIONS=--source-dir ../../includes/gnutls \
+	--source-dir ../../libextra
+
+# Extra options to supply to gtkdoc-mkdb.
+# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
+MKDB_OPTIONS=--output-format=xml $(SCAN_OPTIONS)
+
+# Extra options to supply to gtkdoc-fixref. Not normally needed.
+# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
+FIXXREF_OPTIONS=
+
+# Used for dependencies. The docs will be rebuilt if any of these change.
+# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
+# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
+HFILE_GLOB=$(top_srcdir)/lib/*.h
+CFILE_GLOB=$(top_srcdir)/lib/*.c
+
+# Header files to ignore when scanning.
+# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
+IGNORE_HFILES=debug.h gnutls_compress.h defines.h gnutls_cipher.h	\
+	gnutls_buffers.h gnutls_errors.h gnutls_int.h			\
+	gnutls_handshake.h gnutls_num.h gnutls_algorithms.h		\
+	gnutls_dh.h gnutls_kx.h gnutls_hash_int.h gnutls_cipher_int.h	\
+	gnutls_db.h gnutls_compress_int.h gnutls_session.h		\
+	gnutls_priority.h gnutls_auth.h auth_anon.h			\
+	gnutls_extensions.h gnutls_buffer.h gnutls_auth_int.h		\
+	gnutls_random.h x509_b64.h gnutls_v2_compat.h			\
+	gnutls_errors_int.h gnutls_datum.h auth_cert.h gnutls_mpi.h	\
+	gnutls_pk.h gnutls_record.h gnutls_cert.h gnutls_constate.h	\
+	gnutls_global.h strfile.h gnutls_sig.h gnutls_mem.h		\
+	gnutls_ui.h io_debug.h ext_max_record.h gnutls_session_pack.h	\
+	gnutls_alert.h gnutls_str.h gnutls_state.h gnutls_x509.h	\
+	ext_cert_type.h gnutls_rsa_export.h ext_server_name.h		\
+	auth_dh_common.h ext_srp.h gnutls_srp.h auth_srp.h		\
+	auth_srp_passwd.h memmem.h					\
+									\
+	der.h errors.h gstr.h libtasn1.h parser_aux.h element.h		\
+	errors_int.h int.h mem.h structure.h				\
+									\
+	common.h crq.h dsa.h mpi.h pkcs7.h rfc2818.h verify.h compat.h	\
+	dn.h extensions.h privkey.h sign.h				\
+									\
+	gnutls_extra.h lzoconf.h minilzo.h openssl_compat.h		\
+									\
+	cipher.h context.h filters.h main.h md.h opencdk.h packet.h	\
+	stream.h types.h						\
+									\
+	gnutls_openpgp.h
+
+
+# Images to copy into HTML directory.
+# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
+HTML_IMAGES=
+
+# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
+# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
+content_files=
+
+# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
+# Only needed if you are using gtkdoc-scangobj to dynamically query widget
+# signals and properties.
+# e.g. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
+# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
+INCLUDES=
+GTKDOC_LIBS=
+
+# This includes the standard gtk-doc make rules, copied by gtkdocize.
+include $(top_srcdir)/gtk-doc.make
+
+# Other files to distribute
+# e.g. EXTRA_DIST += version.xml.in
+EXTRA_DIST +=