hal/doc/api Doxyfile.in, 1.3, NONE Makefile.am, 1.3, 1.4 hal-docs.xml, NONE, 1.1

David Zeuthen david at kemper.freedesktop.org
Sat Feb 25 12:38:25 PST 2006


Update of /cvs/hal/hal/doc/api
In directory kemper:/tmp/cvs-serv7058/doc/api

Modified Files:
	Makefile.am 
Added Files:
	hal-docs.xml 
Removed Files:
	Doxyfile.in 
Log Message:
2006-02-25  David Zeuthen  <davidz at redhat.com>

        * libhal/libhal.[ch]: Convert doc comments from Doxygen to gtk-doc

        * libhal-storage/libhal-storage.[ch]: Convert doc comments from
        Doxygen to gtk-doc (not completely done)

        * doc/api/hal-docs.xml: New file

        * doc/api/Doxyfile.in: Remove

        * doc/api/Makefile.am: Use gtk-doc instead of Doxygen

        * configure.in: Various cleanups; use gtk-doc instead of Doxygen

        * autogen.sh: Pass --enable-gtk-doc to configure.

        * acinclude.m4: Add GTK_DOC_CHECK, from cairo, thanks.



--- Doxyfile.in DELETED ---

Index: Makefile.am
===================================================================
RCS file: /cvs/hal/hal/doc/api/Makefile.am,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -d -r1.3 -r1.4
--- Makefile.am	1 Jul 2005 18:16:46 -0000	1.3
+++ Makefile.am	25 Feb 2006 20:38:23 -0000	1.4
@@ -1,16 +1,46 @@
 
-if DOXYGEN_DOCS_ENABLED
+## Process this file with automake to create Makefile.in.
 
-EXTRA_DIST = Doxyfile Doxyfile.in
+AUTOMAKE_OPTIONS = 1.7
 
-htmldocdir = $(DOCDIR)/api
-htmldoc_DATA = html/*
+# The name of the module.
+DOC_MODULE=hal
 
-html/* : Doxyfile
-	$(DOXYGEN)
+# The top-level SGML file.
+DOC_MAIN_SGML_FILE=hal-docs.xml
 
-clean-local:
-	rm -f *~
-	rm -rf html
+# Extra options to supply to gtkdoc-scan
+#SCAN_OPTIONS=--deprecated-guards="CAIRO_DISABLE_DEPRECATED"
+
+# The directory containing the source code. Relative to $(srcdir)
+DOC_SOURCE_DIR=../..
+
+# Used for dependencies
+HFILE_GLOB=$(top_srcdir)/libhal/*.h $(top_srcdir)/libhal-storage/*.h $(top_srcdir)/libhal-policy/*.h
+CFILE_GLOB=$(top_srcdir)/libhal/*.c $(top_srcdir)/libhal-storage/*.c $(top_srcdir)/libhal-policy/*.c
+
+# Headers to ignore
+IGNORE_HFILES=
+
+# CFLAGS and LDFLAGS for compiling scan program. Only needed
+# if $(DOC_MODULE).types is non-empty.
+INCLUDES =
+GTKDOC_LIBS =
+
+# Extra options to supply to gtkdoc-mkdb
+MKDB_OPTIONS=--sgml-mode --output-format=xml
+
+# Extra options to supply to gtkdoc-mktmpl
+MKTMPL_OPTIONS=
+
+# Non-autogenerated SGML files to be included in $(DOC_MAIN_SGML_FILE)
+content_files =
+
+# Images to copy into HTML directory
+HTML_IMAGES =
+
+# Extra options to supply to gtkdoc-fixref
+FIXXREF_OPTIONS=
+
+include $(top_srcdir)/gtk-doc.make
 
-endif # DOXYGEN_DOCS_ENABLED

--- NEW FILE: hal-docs.xml ---
<?xml version="1.0"?>
<!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/2003/XInclude">
  <bookinfo>
    <title>HAL Reference Manual</title>
  </bookinfo>

  <chapter>
    <title>Client library</title>
    <xi:include href="xml/libhal.xml"/>
  </chapter>

  <chapter>
    <title>Storage devices and volumes</title>
    <xi:include href="xml/libhal-storage.xml"/>
  </chapter>

  <chapter>
    <title>Querying and modifying policies</title>
    <xi:include href="xml/libhal-policy.xml"/>
  </chapter>
</book>




More information about the hal-commit mailing list