summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDaniel P. Berrange <berrange@redhat.com>2010-08-31 16:44:35 +0100
committerDaniel P. Berrange <berrange@redhat.com>2010-09-01 12:06:09 +0100
commit5351c778c43f8bf28d7bb13ca8d5942ea306d4d5 (patch)
tree4bb0bb29da19c2e651bfbcd40c18462a8cc44fb9 /docs
parent803eedcfefc67c2239afdc1999652beda3f986d7 (diff)
Integrate gtk-doc into the build for API docs
* Makefile.am: Add docs subdir * autogen.sh: Enable gtk-doc build by default * configure.ac: Add check for gtk-doc * doc/api.txt, doc/overview.txt: Remove inaccurate, outdated docs * docs/Makefile.am: Add reference/ subdir * docs/reference/: bare template for gtk-doc content
Diffstat (limited to 'docs')
-rw-r--r--docs/Makefile.am2
-rw-r--r--docs/reference/.gitignore26
-rw-r--r--docs/reference/Libosinfo-docs.xml41
-rw-r--r--docs/reference/Libosinfo-overrides.txt0
-rw-r--r--docs/reference/Libosinfo-sections.txt265
-rw-r--r--docs/reference/Libosinfo.types12
-rw-r--r--docs/reference/Makefile.am42
7 files changed, 388 insertions, 0 deletions
diff --git a/docs/Makefile.am b/docs/Makefile.am
new file mode 100644
index 0000000..cac25f2
--- /dev/null
+++ b/docs/Makefile.am
@@ -0,0 +1,2 @@
+
+SUBDIRS = reference
diff --git a/docs/reference/.gitignore b/docs/reference/.gitignore
new file mode 100644
index 0000000..2e91cb2
--- /dev/null
+++ b/docs/reference/.gitignore
@@ -0,0 +1,26 @@
+html-build.stamp
+html.stamp
+scan-build.stamp
+sgml-build.stamp
+sgml.stamp
+tmpl-build.stamp
+tmpl.stamp
+.args
+.hierarchy
+.interfaces
+.prerequisites
+.signals
+xml/
+html/
+tmpl/
+Libosinfo-decl.txt
+Libosinfo-decl.txt.bak
+Libosinfo-decl-list.txt
+Libosinfo-undeclared.txt
+Libosinfo-undocumented.txt
+Libosinfo-unused.txt
+Libosinfo.args
+Libosinfo.hierarchy
+Libosinfo.interfaces
+Libosinfo.prerequisites
+Libosinfo.signals
diff --git a/docs/reference/Libosinfo-docs.xml b/docs/reference/Libosinfo-docs.xml
new file mode 100644
index 0000000..44b5506
--- /dev/null
+++ b/docs/reference/Libosinfo-docs.xml
@@ -0,0 +1,41 @@
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+ "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
+[
+ <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
+]>
+<book id="index">
+ <bookinfo>
+ <title>Libosinfo Reference Manual</title>
+ <releaseinfo>
+<!-- The latest version of this documentation can be found on-line at
+ <ulink role="online-location" url="http://[SERVER]/Libosinfo/index.html">http://[SERVER]/Libosinfo/</ulink>.-->
+ </releaseinfo>
+ </bookinfo>
+
+ <chapter>
+ <title>Libosinfo</title>
+ <xi:include href="xml/osinfo_db.xml"/>
+ <xi:include href="xml/osinfo_device.xml"/>
+ <xi:include href="xml/osinfo_devicelist.xml"/>
+ <xi:include href="xml/osinfo_entity.xml"/>
+ <xi:include href="xml/osinfo_filter.xml"/>
+ <xi:include href="xml/osinfo_hypervisor.xml"/>
+ <xi:include href="xml/osinfo_hypervisorlist.xml"/>
+ <xi:include href="xml/osinfo_list.xml"/>
+ <xi:include href="xml/osinfo_loader.xml"/>
+ <xi:include href="xml/osinfo_os.xml"/>
+ <xi:include href="xml/osinfo_osfilter.xml"/>
+ <xi:include href="xml/osinfo_oslist.xml"/>
+ </chapter>
+ <chapter id="object-tree">
+ <title>Object Hierarchy</title>
+ <xi:include href="xml/tree_index.sgml"/>
+ </chapter>
+ <index id="api-index-full">
+ <title>API Index</title>
+ <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
+ </index>
+
+ <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
+</book>
diff --git a/docs/reference/Libosinfo-overrides.txt b/docs/reference/Libosinfo-overrides.txt
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/docs/reference/Libosinfo-overrides.txt
diff --git a/docs/reference/Libosinfo-sections.txt b/docs/reference/Libosinfo-sections.txt
new file mode 100644
index 0000000..ff24b1d
--- /dev/null
+++ b/docs/reference/Libosinfo-sections.txt
@@ -0,0 +1,265 @@
+<SECTION>
+<FILE>osinfo_db</FILE>
+<TITLE>OsinfoDb</TITLE>
+OsinfoDb
+OsinfoDbClass
+OsinfoDbPrivate
+osinfo_db_new
+osinfo_db_get_hypervisor
+osinfo_db_get_device
+osinfo_db_get_os
+osinfo_db_get_os_list
+osinfo_db_get_hypervisor_list
+osinfo_db_get_device_list
+osinfo_db_add_os
+osinfo_db_add_hypervisor
+osinfo_db_add_device
+osinfo_db_unique_values_for_property_in_os
+osinfo_db_unique_values_for_property_in_hv
+osinfo_db_unique_values_for_property_in_dev
+osinfo_db_unique_values_for_os_relationship
+<SUBSECTION Standard>
+OSINFO_DB
+OSINFO_IS_DB
+OSINFO_TYPE_DB
+osinfo_db_get_type
+OSINFO_DB_CLASS
+OSINFO_IS_DB_CLASS
+OSINFO_DB_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>osinfo_list</FILE>
+<TITLE>OsinfoList</TITLE>
+OsinfoList
+OsinfoListClass
+OsinfoListPrivate
+osinfo_list_get_element_type
+osinfo_list_get_length
+osinfo_list_get_nth
+osinfo_list_find_by_id
+osinfo_list_add
+osinfo_list_add_filtered
+osinfo_list_add_intersection
+osinfo_list_add_union
+osinfo_list_add_all
+osinfo_list_iterator
+osinfo_list_foreach
+<SUBSECTION Standard>
+OSINFO_LIST
+OSINFO_IS_LIST
+OSINFO_TYPE_LIST
+osinfo_list_get_type
+OSINFO_LIST_CLASS
+OSINFO_IS_LIST_CLASS
+OSINFO_LIST_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>osinfo_loader</FILE>
+<TITLE>OsinfoLoader</TITLE>
+OsinfoLoader
+OsinfoLoaderClass
+OsinfoLoaderPrivate
+osinfo_loader_new
+osinfo_loader_get_db
+osinfo_loader_process_path
+osinfo_loader_process_uri
+<SUBSECTION Standard>
+OSINFO_LOADER
+OSINFO_IS_LOADER
+OSINFO_TYPE_LOADER
+osinfo_loader_get_type
+OSINFO_LOADER_CLASS
+OSINFO_IS_LOADER_CLASS
+OSINFO_LOADER_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>osinfo_os</FILE>
+<TITLE>OsinfoOs</TITLE>
+OsinfoOs
+OsinfoOsClass
+OsinfoOsPrivate
+OsinfoOsRelationship
+osinfo_os_new
+osinfo_os_get_preferred_device
+osinfo_os_get_related
+osinfo_os_get_devices
+osinfo_os_add_device
+osinfo_os_add_related_os
+<SUBSECTION Standard>
+OSINFO_OS
+OSINFO_IS_OS
+OSINFO_TYPE_OS
+osinfo_os_get_type
+OSINFO_OS_CLASS
+OSINFO_IS_OS_CLASS
+OSINFO_OS_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>osinfo_hypervisor</FILE>
+<TITLE>OsinfoHypervisor</TITLE>
+OsinfoHypervisor
+OsinfoHypervisorClass
+OsinfoHypervisorPrivate
+osinfo_hypervisor_new
+osinfo_hypervisor_get_devices
+osinfo_hypervisor_add_device
+<SUBSECTION Standard>
+OSINFO_HYPERVISOR
+OSINFO_IS_HYPERVISOR
+OSINFO_TYPE_HYPERVISOR
+osinfo_hypervisor_get_type
+OSINFO_HYPERVISOR_CLASS
+OSINFO_IS_HYPERVISOR_CLASS
+OSINFO_HYPERVISOR_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>osinfo_filter</FILE>
+<TITLE>OsinfoFilter</TITLE>
+OsinfoFilter
+OsinfoFilterClass
+OsinfoFilterPrivate
+osinfo_filter_new
+osinfo_filter_add_constraint
+osinfo_filter_clear_constraint
+osinfo_filter_clear_constraints
+osinfo_filter_get_constraint_keys
+osinfo_filter_get_constraint_values
+osinfo_filter_matches
+<SUBSECTION Standard>
+OSINFO_FILTER
+OSINFO_IS_FILTER
+OSINFO_TYPE_FILTER
+osinfo_filter_get_type
+OSINFO_FILTER_CLASS
+OSINFO_IS_FILTER_CLASS
+OSINFO_FILTER_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>osinfo_entity</FILE>
+<TITLE>OsinfoEntity</TITLE>
+OsinfoEntity
+OsinfoEntityClass
+OsinfoEntityPrivate
+osinfo_entity_get_id
+osinfo_entity_get_param_keys
+osinfo_entity_get_param_value
+osinfo_entity_get_param_value_list
+osinfo_entity_add_param
+osinfo_entity_clear_param
+<SUBSECTION Standard>
+OSINFO_ENTITY
+OSINFO_IS_ENTITY
+OSINFO_TYPE_ENTITY
+osinfo_entity_get_type
+OSINFO_ENTITY_CLASS
+OSINFO_IS_ENTITY_CLASS
+OSINFO_ENTITY_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>osinfo_devicelist</FILE>
+<TITLE>OsinfoDeviceList</TITLE>
+OsinfoDeviceList
+OsinfoDeviceListClass
+OsinfoDeviceListPrivate
+osinfo_devicelist_new
+osinfo_devicelist_new_copy
+osinfo_devicelist_new_filtered
+osinfo_devicelist_new_intersection
+osinfo_devicelist_new_union
+<SUBSECTION Standard>
+OSINFO_DEVICELIST
+OSINFO_IS_DEVICELIST
+OSINFO_TYPE_DEVICELIST
+osinfo_devicelist_get_type
+OSINFO_DEVICELIST_CLASS
+OSINFO_IS_DEVICELIST_CLASS
+OSINFO_DEVICELIST_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>osinfo_osfilter</FILE>
+<TITLE>OsinfoOsfilter</TITLE>
+OsinfoOsfilter
+OsinfoOsfilterClass
+OsinfoOsfilterPrivate
+osinfo_osfilter_new
+osinfo_osfilter_add_os_constraint
+osinfo_osfilter_clear_os_constraint
+osinfo_osfilter_clear_os_constraints
+osinfo_osfilter_get_os_constraint_values
+<SUBSECTION Standard>
+OSINFO_OSFILTER
+OSINFO_IS_OSFILTER
+OSINFO_TYPE_OSFILTER
+osinfo_osfilter_get_type
+OSINFO_OSFILTER_CLASS
+OSINFO_IS_OSFILTER_CLASS
+OSINFO_OSFILTER_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>osinfo_oslist</FILE>
+<TITLE>OsinfoOsList</TITLE>
+OsinfoOsList
+OsinfoOsListClass
+OsinfoOsListPrivate
+osinfo_oslist_new
+osinfo_oslist_new_copy
+osinfo_oslist_new_filtered
+osinfo_oslist_new_intersection
+osinfo_oslist_new_union
+<SUBSECTION Standard>
+OSINFO_OSLIST
+OSINFO_IS_OSLIST
+OSINFO_TYPE_OSLIST
+osinfo_oslist_get_type
+OSINFO_OSLIST_CLASS
+OSINFO_IS_OSLIST_CLASS
+OSINFO_OSLIST_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>osinfo_hypervisorlist</FILE>
+<TITLE>OsinfoHypervisorList</TITLE>
+OsinfoHypervisorList
+OsinfoHypervisorListClass
+OsinfoHypervisorListPrivate
+osinfo_hypervisorlist_new
+osinfo_hypervisorlist_new_copy
+osinfo_hypervisorlist_new_filtered
+osinfo_hypervisorlist_new_intersection
+osinfo_hypervisorlist_new_union
+<SUBSECTION Standard>
+OSINFO_HYPERVISORLIST
+OSINFO_IS_HYPERVISORLIST
+OSINFO_TYPE_HYPERVISORLIST
+osinfo_hypervisorlist_get_type
+OSINFO_HYPERVISORLIST_CLASS
+OSINFO_IS_HYPERVISORLIST_CLASS
+OSINFO_HYPERVISORLIST_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>osinfo_device</FILE>
+<TITLE>OsinfoDevice</TITLE>
+OsinfoDevice
+OsinfoDeviceClass
+OsinfoDevicePrivate
+osinfo_device_new
+<SUBSECTION Standard>
+OSINFO_DEVICE
+OSINFO_IS_DEVICE
+OSINFO_TYPE_DEVICE
+osinfo_device_get_type
+OSINFO_DEVICE_CLASS
+OSINFO_IS_DEVICE_CLASS
+OSINFO_DEVICE_GET_CLASS
+</SECTION>
+
diff --git a/docs/reference/Libosinfo.types b/docs/reference/Libosinfo.types
new file mode 100644
index 0000000..94d0617
--- /dev/null
+++ b/docs/reference/Libosinfo.types
@@ -0,0 +1,12 @@
+osinfo_db_get_type
+osinfo_device_get_type
+osinfo_devicelist_get_type
+osinfo_entity_get_type
+osinfo_filter_get_type
+osinfo_hypervisor_get_type
+osinfo_hypervisorlist_get_type
+osinfo_list_get_type
+osinfo_loader_get_type
+osinfo_os_get_type
+osinfo_osfilter_get_type
+osinfo_oslist_get_type
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
new file mode 100644
index 0000000..5c31e10
--- /dev/null
+++ b/docs/reference/Makefile.am
@@ -0,0 +1,42 @@
+
+DOC_MODULE=Libosinfo
+
+DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
+
+DOC_SOURCE_DIR=$(top_srcdir)/osinfo
+
+SCANGOBJ_OPTIONS=
+
+SCAN_OPTIONS=
+
+MKDB_OPTIONS=--sgml-mode --output-format=xml
+
+MKTMPL_OPTIONS=
+
+MKHTML_OPTIONS=
+
+FIXXREF_OPTIONS=
+
+HFILE_GLOB=$(top_srcdir)/osinfo/*.h
+CFILE_GLOB=$(top_srcdir)/osinfo/*.c
+
+IGNORE_HFILES=
+
+HTML_IMAGES=
+
+content_files=
+
+expand_content_files=
+
+GTKDOC_CFLAGS= \
+ $(LIBXML_CFLAGS) \
+ $(GOBJECT_CFLAGS)\
+ $(GIO_CFLAGS)
+GTKDOC_LIBS = \
+ $(LIBXML_LIBS) \
+ $(GOBJECT_LIBS) \
+ $(GIO_LIBS) \
+ $(top_builddir)/osinfo/libosinfo-1.0.la
+
+include $(top_srcdir)/gtk-doc.make
+