hal: Branch 'master'
David Zeuthen
david at kemper.freedesktop.org
Mon Mar 12 12:30:20 PDT 2007
doc/api/libhal-storage/.gitignore | 15 +++
doc/api/libhal-storage/Makefile.am | 67 +++++++++++++++
doc/api/libhal-storage/libhal-storage-docs.xml | 109 +++++++++++++++++++++++++
doc/api/libhal-storage/version.xml.in | 1
doc/api/libhal/.gitignore | 15 +++
doc/api/libhal/Makefile.am | 67 +++++++++++++++
doc/api/libhal/libhal-docs.xml | 109 +++++++++++++++++++++++++
doc/api/libhal/version.xml.in | 1
8 files changed, 384 insertions(+)
New commits:
diff-tree 66871d2a413f447ef8d89a763a0362ce38383801 (from b53fd153f48c55ac9fcb677f1ecaea47b6f9ca3a)
Author: William Jon McCann <mccann at jhu.edu>
Date: Mon Mar 12 15:30:16 2007 -0400
improve api docs
Here's a patch to fix up some gtk-doc issues.
* It installs separate manuals for each of the libraries
* Adds GLIB_CFLAGS/LIBS so it builds
* Avoids scanning the hald directory (by using separate manuals)
* Adds some licence info to the manuals
* Adds an index to each manual
* Fixes up maintainer-clean
diff --git a/doc/api/libhal-storage/.gitignore b/doc/api/libhal-storage/.gitignore
new file mode 100644
index 0000000..0b12d0a
--- /dev/null
+++ b/doc/api/libhal-storage/.gitignore
@@ -0,0 +1,15 @@
+Makefile
+Makefile.in
+html
+xml
+libhal-storage.hierarchy
+libhal-storage.interfaces
+libhal-storage.prerequisites
+libhal-storage.signals
+*.txt
+*.bak
+*.args
+*.stamp
+*.o
+tmpl
+*~
diff --git a/doc/api/libhal-storage/Makefile.am b/doc/api/libhal-storage/Makefile.am
new file mode 100644
index 0000000..167c72e
--- /dev/null
+++ b/doc/api/libhal-storage/Makefile.am
@@ -0,0 +1,67 @@
+## Process this file with automake to create Makefile.in.
+
+NULL =
+
+AUTOMAKE_OPTIONS = 1.7
+
+# The name of the module.
+DOC_MODULE=libhal-storage
+
+# The top-level SGML file.
+DOC_MAIN_SGML_FILE=libhal-storage-docs.xml
+
+# 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=../../../libhal-storage
+
+# Used for dependencies
+HFILE_GLOB=$(top_srcdir)/libhal-storage/*.h
+CFILE_GLOB=$(top_srcdir)/libhal-storage/*.c
+
+# Headers to ignore
+IGNORE_HFILES= \
+ $(NULL)
+
+# CFLAGS and LDFLAGS for compiling scan program. Only needed
+# if $(DOC_MODULE).types is non-empty.
+INCLUDES = \
+ $(GLIB_CFLAGS) \
+ -I$(top_srcdir) \
+ -I$(top_builddir) \
+ $(NULL)
+
+GTKDOC_LIBS = \
+ $(GLIB_LIBS) \
+ $(top_builddir)/libhal-storage/libhal-storage.la \
+ $(NULL)
+
+# 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 = \
+ version.xml \
+ $(NULL)
+
+# Extra options to supply to gtkdoc-fixref
+FIXXREF_OPTIONS=
+
+MAINTAINERCLEANFILES = \
+ *~ \
+ Makefile.in \
+ libhal-storage.types \
+ libhal-storage-*.txt \
+ $(NULL)
+
+include $(top_srcdir)/gtk-doc.make
+
+# Version information for marking the documentation
+EXTRA_DIST += version.xml.in
diff --git a/doc/api/libhal-storage/libhal-storage-docs.xml b/doc/api/libhal-storage/libhal-storage-docs.xml
new file mode 100644
index 0000000..39c8d32
--- /dev/null
+++ b/doc/api/libhal-storage/libhal-storage-docs.xml
@@ -0,0 +1,109 @@
+<?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" [
+<!ENTITY version SYSTEM "version.xml">
+]>
+<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
+ <bookinfo>
+ <title>HAL Storage Library Reference Manual</title>
+ <releaseinfo>Version &version;</releaseinfo>
+ <authorgroup>
+ <author>
+ <firstname>David</firstname>
+ <surname>Zeuthen</surname>
+ <affiliation>
+ <address>
+ <email>david at fubar.dk</email>
+ </address>
+ </affiliation>
+ </author>
+ </authorgroup>
+
+ <copyright>
+ <year>2007</year>
+ <holder>The HAL Authors</holder>
+ </copyright>
+
+ <legalnotice>
+ <para>
+ Permission is granted to copy, distribute and/or modify this
+ document under the terms of the <citetitle>GNU Free
+ Documentation License</citetitle>, Version 1.1 or any later
+ version published by the Free Software Foundation with no
+ Invariant Sections, no Front-Cover Texts, and no Back-Cover
+ Texts. You may obtain a copy of the <citetitle>GNU Free
+ Documentation License</citetitle> from the Free Software
+ Foundation by visiting <ulink type="http"
+ url="http://www.fsf.org">their Web site</ulink> or by writing
+ to:
+
+ <address>
+ The Free Software Foundation, Inc.,
+ <street>59 Temple Place</street> - Suite 330,
+ <city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>,
+ <country>USA</country>
+ </address>
+ </para>
+
+ <para>
+ Many of the names used by companies to distinguish their
+ products and services are claimed as trademarks. Where those
+ names appear in any GNOME documentation, and those trademarks
+ are made aware to the members of the GNOME Documentation
+ Project, the names have been printed in caps or initial caps.
+ </para>
+ </legalnotice>
+ </bookinfo>
+
+ <reference>
+ <title>API Reference</title>
+
+ <partintro>
+ <para>
+ This part presents the class and function reference for the
+ HAL storage client library.
+ </para>
+ </partintro>
+ <xi:include href="xml/libhal-storage.xml"/>
+ </reference>
+
+ <index>
+ <title>Index</title>
+ </index>
+
+ <!-- License -->
+
+ <appendix id="license">
+ <title>License</title>
+
+ <para>
+ This library is free software; you can redistribute it and/or
+ modify it under the terms of the <citetitle>GNU General
+ Public License</citetitle> as published by the Free Software
+ Foundation; either version 2 of the License, or (at your option)
+ any later version.
+ </para>
+
+ <para>
+ This library 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
+ <citetitle>GNU Library General Public License</citetitle> for
+ more details.
+ </para>
+
+ <para>
+ You may obtain a copy of the <citetitle>GNU General
+ Public License</citetitle> from the Free Software Foundation by
+ visiting <ulink type="http" url="http://www.fsf.org">their Web
+ site</ulink> or by writing to:
+
+ <address>
+ Free Software Foundation, Inc.
+ <street>59 Temple Place</street> - Suite 330
+ <city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>
+ <country>USA</country>
+ </address>
+ </para>
+ </appendix>
+</book>
diff --git a/doc/api/libhal-storage/version.xml.in b/doc/api/libhal-storage/version.xml.in
new file mode 100644
index 0000000..d78bda9
--- /dev/null
+++ b/doc/api/libhal-storage/version.xml.in
@@ -0,0 +1 @@
+ at VERSION@
diff --git a/doc/api/libhal/.gitignore b/doc/api/libhal/.gitignore
new file mode 100644
index 0000000..172c04c
--- /dev/null
+++ b/doc/api/libhal/.gitignore
@@ -0,0 +1,15 @@
+Makefile
+Makefile.in
+html
+xml
+libhal.hierarchy
+libhal.interfaces
+libhal.prerequisites
+libhal.signals
+*.txt
+*.bak
+*.args
+*.stamp
+*.o
+tmpl
+*~
diff --git a/doc/api/libhal/Makefile.am b/doc/api/libhal/Makefile.am
new file mode 100644
index 0000000..cde6c94
--- /dev/null
+++ b/doc/api/libhal/Makefile.am
@@ -0,0 +1,67 @@
+## Process this file with automake to create Makefile.in.
+
+NULL =
+
+AUTOMAKE_OPTIONS = 1.7
+
+# The name of the module.
+DOC_MODULE=libhal
+
+# The top-level SGML file.
+DOC_MAIN_SGML_FILE=libhal-docs.xml
+
+# 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=../../../libhal
+
+# Used for dependencies
+HFILE_GLOB=$(top_srcdir)/libhal/*.h
+CFILE_GLOB=$(top_srcdir)/libhal/*.c
+
+# Headers to ignore
+IGNORE_HFILES= \
+ $(NULL)
+
+# CFLAGS and LDFLAGS for compiling scan program. Only needed
+# if $(DOC_MODULE).types is non-empty.
+INCLUDES = \
+ $(GLIB_CFLAGS) \
+ -I$(top_srcdir) \
+ -I$(top_builddir) \
+ $(NULL)
+
+GTKDOC_LIBS = \
+ $(GLIB_LIBS) \
+ $(top_builddir)/libhal/libhal.la \
+ $(NULL)
+
+# 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 = \
+ version.xml \
+ $(NULL)
+
+# Images to copy into HTML directory
+HTML_IMAGES =
+
+# Extra options to supply to gtkdoc-fixref
+FIXXREF_OPTIONS=
+
+MAINTAINERCLEANFILES = \
+ *~ \
+ Makefile.in \
+ libhal.types \
+ libhal-*.txt \
+ $(NULL)
+
+include $(top_srcdir)/gtk-doc.make
+
+# Version information for marking the documentation
+EXTRA_DIST += version.xml.in
diff --git a/doc/api/libhal/libhal-docs.xml b/doc/api/libhal/libhal-docs.xml
new file mode 100644
index 0000000..a3048f3
--- /dev/null
+++ b/doc/api/libhal/libhal-docs.xml
@@ -0,0 +1,109 @@
+<?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" [
+<!ENTITY version SYSTEM "version.xml">
+]>
+<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
+ <bookinfo>
+ <title>HAL Client Library Reference Manual</title>
+ <releaseinfo>Version &version;</releaseinfo>
+ <authorgroup>
+ <author>
+ <firstname>David</firstname>
+ <surname>Zeuthen</surname>
+ <affiliation>
+ <address>
+ <email>david at fubar.dk</email>
+ </address>
+ </affiliation>
+ </author>
+ </authorgroup>
+
+ <copyright>
+ <year>2007</year>
+ <holder>The HAL Authors</holder>
+ </copyright>
+
+ <legalnotice>
+ <para>
+ Permission is granted to copy, distribute and/or modify this
+ document under the terms of the <citetitle>GNU Free
+ Documentation License</citetitle>, Version 1.1 or any later
+ version published by the Free Software Foundation with no
+ Invariant Sections, no Front-Cover Texts, and no Back-Cover
+ Texts. You may obtain a copy of the <citetitle>GNU Free
+ Documentation License</citetitle> from the Free Software
+ Foundation by visiting <ulink type="http"
+ url="http://www.fsf.org">their Web site</ulink> or by writing
+ to:
+
+ <address>
+ The Free Software Foundation, Inc.,
+ <street>59 Temple Place</street> - Suite 330,
+ <city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>,
+ <country>USA</country>
+ </address>
+ </para>
+
+ <para>
+ Many of the names used by companies to distinguish their
+ products and services are claimed as trademarks. Where those
+ names appear in any GNOME documentation, and those trademarks
+ are made aware to the members of the GNOME Documentation
+ Project, the names have been printed in caps or initial caps.
+ </para>
+ </legalnotice>
+ </bookinfo>
+
+ <reference>
+ <title>API Reference</title>
+
+ <partintro>
+ <para>
+ This part presents the class and function reference for the
+ HAL client library.
+ </para>
+ </partintro>
+ <xi:include href="xml/libhal.xml"/>
+ </reference>
+
+ <index>
+ <title>Index</title>
+ </index>
+
+ <!-- License -->
+
+ <appendix id="license">
+ <title>License</title>
+
+ <para>
+ This library is free software; you can redistribute it and/or
+ modify it under the terms of the <citetitle>GNU General
+ Public License</citetitle> as published by the Free Software
+ Foundation; either version 2 of the License, or (at your option)
+ any later version.
+ </para>
+
+ <para>
+ This library 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
+ <citetitle>GNU Library General Public License</citetitle> for
+ more details.
+ </para>
+
+ <para>
+ You may obtain a copy of the <citetitle>GNU General
+ Public License</citetitle> from the Free Software Foundation by
+ visiting <ulink type="http" url="http://www.fsf.org">their Web
+ site</ulink> or by writing to:
+
+ <address>
+ Free Software Foundation, Inc.
+ <street>59 Temple Place</street> - Suite 330
+ <city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>
+ <country>USA</country>
+ </address>
+ </para>
+ </appendix>
+</book>
diff --git a/doc/api/libhal/version.xml.in b/doc/api/libhal/version.xml.in
new file mode 100644
index 0000000..d78bda9
--- /dev/null
+++ b/doc/api/libhal/version.xml.in
@@ -0,0 +1 @@
+ at VERSION@
More information about the hal-commit
mailing list