Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This patch adds gtk-doc-based documentation. The generated docs aren't very complete (or even correct) but this is a good start.
- Loading branch information
Showing
15 changed files
with
929 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| SUBDIRS = libvirt-glib libvirt-gobject libvirt-gconfig |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| <?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>Libvirt-gconfig Reference Manual</title> | ||
| </bookinfo> | ||
|
|
||
| <chapter> | ||
| <title>Libvirt-gconfig</title> | ||
| <xi:include href="xml/libvirt-gconfig-object.xml"/> | ||
| <xi:include href="xml/libvirt-gconfig-domain.xml"/> | ||
| <xi:include href="xml/libvirt-gconfig-domain-snapshot.xml"/> | ||
| <xi:include href="xml/libvirt-gconfig-interface.xml"/> | ||
| <xi:include href="xml/libvirt-gconfig-network-filter.xml"/> | ||
| <xi:include href="xml/libvirt-gconfig-network.xml"/> | ||
| <xi:include href="xml/libvirt-gconfig-node-device.xml"/> | ||
| <xi:include href="xml/libvirt-gconfig-secret.xml"/> | ||
| <xi:include href="xml/libvirt-gconfig-storage-pool.xml"/> | ||
| <xi:include href="xml/libvirt-gconfig-storage-vol.xml"/> | ||
| <xi:include href="xml/libvirt-gconfig-capabilities.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> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,166 @@ | ||
| <SECTION> | ||
| <FILE>libvirt-gconfig-object</FILE> | ||
| <TITLE>GVirConfigObject</TITLE> | ||
| gvir_config_object_validate | ||
| gvir_config_object_get_doc | ||
| gvir_config_object_get_schema | ||
| <SUBSECTION Standard> | ||
| GVIR_TYPE_OBJECT | ||
| GVIR_OBJECT | ||
| GVIR_OBJECT_CLASS | ||
| GVIR_IS_OBJECT | ||
| GVIR_IS_OBJECT_CLASS | ||
| GVIR_OBJECT_GET_CLASS | ||
| <SUBSECTION Private> | ||
| GVirConfigObjectPrivate | ||
| </SECTION> | ||
|
|
||
| <SECTION> | ||
| <FILE>libvirt-gconfig-domain</FILE> | ||
| <TITLE>GVirConfigDomain</TITLE> | ||
| gvir_config_domain_new | ||
| <SUBSECTION Standard> | ||
| GVIR_TYPE_DOMAIN | ||
| GVIR_DOMAIN | ||
| GVIR_DOMAIN_CLASS | ||
| GVIR_IS_DOMAIN | ||
| GVIR_IS_DOMAIN_CLASS | ||
| GVIR_DOMAIN_GET_CLASS | ||
| <SUBSECTION Private> | ||
| GVirConfigDomainPrivate | ||
| </SECTION> | ||
|
|
||
| <SECTION> | ||
| <FILE>libvirt-gconfig-domain-snapshot</FILE> | ||
| <TITLE>GVirConfigDomainSnapshot</TITLE> | ||
| gvir_config_domain_snapshot_new | ||
| <SUBSECTION Standard> | ||
| GVIR_TYPE_DOMAIN_SNAPSHOT | ||
| GVIR_DOMAIN_SNAPSHOT | ||
| GVIR_DOMAIN_SNAPSHOT_CLASS | ||
| GVIR_IS_DOMAIN_SNAPSHOT | ||
| GVIR_IS_DOMAIN_SNAPSHOT_CLASS | ||
| GVIR_DOMAIN_SNAPSHOT_GET_CLASS | ||
| <SUBSECTION Private> | ||
| GVirConfigDomainSnapshotPrivate | ||
| </SECTION> | ||
|
|
||
| <SECTION> | ||
| <FILE>libvirt-gconfig-interface</FILE> | ||
| <TITLE>GVirConfigInterface</TITLE> | ||
| gvir_config_interface_new | ||
| <SUBSECTION Standard> | ||
| GVIR_TYPE_INTERFACE | ||
| GVIR_INTERFACE | ||
| GVIR_INTERFACE_CLASS | ||
| GVIR_IS_INTERFACE | ||
| GVIR_IS_INTERFACE_CLASS | ||
| GVIR_INTERFACE_GET_CLASS | ||
| <SUBSECTION Private> | ||
| GVirConfigInterfacePrivate | ||
| </SECTION> | ||
|
|
||
| <SECTION> | ||
| <FILE>libvirt-gconfig-network-filter</FILE> | ||
| <TITLE>GVirConfigNetworkFilter</TITLE> | ||
| gvir_config_network_filter_new | ||
| <SUBSECTION Standard> | ||
| GVIR_TYPE_NETWORK_FILTER | ||
| GVIR_NETWORK_FILTER | ||
| GVIR_NETWORK_FILTER_CLASS | ||
| GVIR_IS_NETWORK_FILTER | ||
| GVIR_IS_NETWORK_FILTER_CLASS | ||
| GVIR_NETWORK_FILTER_GET_CLASS | ||
| <SUBSECTION Private> | ||
| GVirConfigNetworkFilterPrivate | ||
| </SECTION> | ||
|
|
||
| <SECTION> | ||
| <FILE>libvirt-gconfig-network</FILE> | ||
| <TITLE>GVirConfigNetwork</TITLE> | ||
| gvir_config_network_new | ||
| <SUBSECTION Standard> | ||
| GVIR_TYPE_NETWORK | ||
| GVIR_NETWORK | ||
| GVIR_NETWORK_CLASS | ||
| GVIR_IS_NETWORK | ||
| GVIR_IS_NETWORK_CLASS | ||
| GVIR_NETWORK_GET_CLASS | ||
| <SUBSECTION Private> | ||
| GVirConfigNetworkPrivate | ||
| </SECTION> | ||
|
|
||
| <SECTION> | ||
| <FILE>libvirt-gconfig-node-device</FILE> | ||
| <TITLE>GVirConfigNodeDevice</TITLE> | ||
| gvir_config_node_device_new | ||
| <SUBSECTION Standard> | ||
| GVIR_TYPE_NODE_DEVICE | ||
| GVIR_NODE_DEVICE | ||
| GVIR_NODE_DEVICE_CLASS | ||
| GVIR_IS_NODE_DEVICE | ||
| GVIR_IS_NODE_DEVICE_CLASS | ||
| GVIR_NODE_DEVICE_GET_CLASS | ||
| <SUBSECTION Private> | ||
| GVirConfigNodeDevicePrivate | ||
| </SECTION> | ||
|
|
||
| <SECTION> | ||
| <FILE>libvirt-gconfig-secret</FILE> | ||
| <TITLE>GVirConfigSecret</TITLE> | ||
| gvir_config_secret_get_new | ||
| <SUBSECTION Standard> | ||
| GVIR_TYPE_SECRET | ||
| GVIR_SECRET | ||
| GVIR_SECRET_CLASS | ||
| GVIR_IS_SECRET | ||
| GVIR_IS_SECRET_CLASS | ||
| GVIR_SECRET_GET_CLASS | ||
| <SUBSECTION Private> | ||
| GVirConfigSecretPrivate | ||
| </SECTION> | ||
|
|
||
| <SECTION> | ||
| <FILE>libvirt-gconfig-storage-pool</FILE> | ||
| <TITLE>GVirConfigStoragePool</TITLE> | ||
| gvir_config_storage_pool_new | ||
| <SUBSECTION Standard> | ||
| GVIR_TYPE_STORAGE_POOL | ||
| GVIR_STORAGE_POOL | ||
| GVIR_STORAGE_POOL_CLASS | ||
| GVIR_IS_STORAGE_POOL | ||
| GVIR_IS_STORAGE_POOL_CLASS | ||
| GVIR_STORAGE_POOL_GET_CLASS | ||
| <SUBSECTION Private> | ||
| GVirConfigStoragePoolPrivate | ||
| </SECTION> | ||
|
|
||
| <SECTION> | ||
| <FILE>libvirt-gconfig-storage-vol</FILE> | ||
| <TITLE>GVirConfigStorageVol</TITLE> | ||
| gvir_config_storage_vol_new | ||
| <SUBSECTION Standard> | ||
| GVIR_TYPE_STORAGE_VOL | ||
| GVIR_STORAGE_VOL | ||
| GVIR_STORAGE_VOL_CLASS | ||
| GVIR_IS_STORAGE_VOL | ||
| GVIR_IS_STORAGE_VOL_CLASS | ||
| GVIR_STORAGE_VOL_GET_CLASS | ||
| <SUBSECTION Private> | ||
| GVirConfigStorageVolPrivate | ||
| </SECTION> | ||
|
|
||
| <SECTION> | ||
| <FILE>libvirt-gconfig-capabilities</FILE> | ||
| <TITLE>GVirConfigCapabilities</TITLE> | ||
| gvir_config_capabilities_new | ||
| <SUBSECTION Standard> | ||
| GVIR_TYPE_CAPABILITIES | ||
| GVIR_CAPABILITIES | ||
| GVIR_CAPABILITIES_CLASS | ||
| GVIR_IS_CAPABILITIES | ||
| GVIR_IS_CAPABILITIES_CLASS | ||
| GVIR_CAPABILITIES_GET_CLASS | ||
| <SUBSECTION Private> | ||
| GVirConfigCapabilitiesPrivate | ||
| </SECTION> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
|
|
||
| DOC_MODULE=Libvirt-gconfig | ||
|
|
||
| DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml | ||
|
|
||
| # Must not use $(top_srcdir) since gtkdoc-scan runs | ||
| # from the srcdir already, not the builddir | ||
| DOC_SOURCE_DIR=../../libvirt-gconfig | ||
|
|
||
| SCANGOBJ_OPTIONS= | ||
|
|
||
| SCAN_OPTIONS= | ||
|
|
||
| MKDB_OPTIONS=--sgml-mode --output-format=xml | ||
|
|
||
| MKTMPL_OPTIONS= | ||
|
|
||
| MKHTML_OPTIONS= | ||
|
|
||
| FIXXREF_OPTIONS= | ||
|
|
||
| HFILE_GLOB=$(top_srcdir)/libvirt-gconfig/*.h | ||
| CFILE_GLOB=$(top_srcdir)/libvirt-gconfig/*.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)/libvirt-gconfig/libvirt-gconfig-1.0.la | ||
|
|
||
| include $(top_srcdir)/gtk-doc.make | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| <?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>Libvirt-glib Reference Manual</title> | ||
| </bookinfo> | ||
|
|
||
| <chapter> | ||
| <title>Libvirt-glib</title> | ||
| <xi:include href="xml/libvirt-glib-main.xml"/> | ||
| <xi:include href="xml/libvirt-glib-error.xml"/> | ||
| <xi:include href="xml/libvirt-glib-event.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> |
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| <SECTION> | ||
| <FILE>libvirt-glib-main</FILE> | ||
| <TITLE>Initialization</TITLE> | ||
| gvir_init | ||
| gvir_init_check | ||
| </SECTION> | ||
|
|
||
| <SECTION> | ||
| <FILE>libvirt-glib-event</FILE> | ||
| <TITLE>Event Handling</TITLE> | ||
| gvir_event_register | ||
| </SECTION> | ||
|
|
||
| <SECTION> | ||
| <FILE>libvirt-glib-error</FILE> | ||
| <TITLE>Error Handling</TITLE> | ||
| gvir_error_new | ||
| gvir_error_new_literal | ||
| gvir_error_new_valist | ||
| </SECTION> | ||
|
|
||
|
|
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
|
|
||
| DOC_MODULE=Libvirt-glib | ||
|
|
||
| DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml | ||
|
|
||
| # Must not use $(top_srcdir) since gtkdoc-scan runs | ||
| # from the srcdir already, not the builddir | ||
| DOC_SOURCE_DIR=../../libvirt-glib | ||
|
|
||
| SCANGOBJ_OPTIONS= | ||
|
|
||
| SCAN_OPTIONS= | ||
|
|
||
| MKDB_OPTIONS=--sgml-mode --output-format=xml | ||
|
|
||
| MKTMPL_OPTIONS= | ||
|
|
||
| MKHTML_OPTIONS= | ||
|
|
||
| FIXXREF_OPTIONS= | ||
|
|
||
| HFILE_GLOB=$(top_srcdir)/libvirt-glib/*.h | ||
| CFILE_GLOB=$(top_srcdir)/libvirt-glib/*.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)/libvirt-glib/libvirt-glib-1.0.la | ||
|
|
||
| include $(top_srcdir)/gtk-doc.make | ||
|
|
Oops, something went wrong.