diff options
author | Siegfried-Angel Gevatter Pujals <rainct@ubuntu.com> | 2012-05-31 23:15:22 +0200 |
---|---|---|
committer | Siegfried-Angel Gevatter Pujals <rainct@ubuntu.com> | 2012-05-31 23:15:22 +0200 |
commit | f4bedb51cf8ba9d401dab76aaad8be6035eea345 (patch) | |
tree | fe95318cdc73ae01b29f884771d6211436aeccbf /doc | |
parent | e2a20656ae4615b91a2662233a0db12de9f94254 (diff) | |
download | zeitgeist-f4bedb51cf8ba9d401dab76aaad8be6035eea345.tar.gz |
libzeitgeist docs.. not working :(
Diffstat (limited to 'doc')
-rw-r--r-- | doc/Makefile.am | 6 | ||||
-rw-r--r-- | doc/libzeitgeist/Makefile.am | 55 | ||||
-rw-r--r-- | doc/libzeitgeist/zeitgeist-2.0-docs.sgml | 54 |
3 files changed, 115 insertions, 0 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index a1f69407..74b2aa72 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,3 +1,9 @@ +NULL = + +SUBDIRS = \ + libzeitgeist \ + $(NULL) + man_MANS = \ zeitgeist-daemon.1 diff --git a/doc/libzeitgeist/Makefile.am b/doc/libzeitgeist/Makefile.am new file mode 100644 index 00000000..e38e957d --- /dev/null +++ b/doc/libzeitgeist/Makefile.am @@ -0,0 +1,55 @@ +## Process this file with automake to produce Makefile.in + +# automake requirements +AUTOMAKE_OPTIONS = 1.7 + +# The name of the module +DOC_MODULE=zeitgeist-2.0 + +# 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). +DOC_SOURCE_DIR = ../../libzeitgeist + +# Extra options to pass to gtkdoc-scangobj. Not normally needed. +SCANGOBJ_OPTIONS = + +# Extra options to supply to gtkdoc-scan. +# Fx --rebuild-types --rebuild-sections +SCAN_OPTIONS = + +# Extra options to supply to gtkdoc-mkdb. +MKDB_OPTIONS = --sgml-mode --output-format=xml --ignore-files=trio + +# Extra options to supply to gtkdoc-fixref. Not normally needed. +FIXXREF_OPTIONS = + +# Used for dependencies. The docs will be rebuilt if any of these change. +HFILE_GLOB = $(top_srcdir)/libzeitgeist/zeitgeist.h +CFILE_GLOB = $(top_srcdir)/libzeitgeist/*.c + +# Header files to ignore when scanning. +IGNORE_HFILES = + +# Images to copy into HTML directory. +HTML_IMAGES = + +# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). +content_files = + +# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library. +INCLUDES= \ + -I$(top_srcdir)/libzeitgeist \ + $(ZEITGEIST_CFLAGS) + +GTKDOC_LIBS = \ + $(ZEITGEIST_LIBS) \ + $(top_builddir)/libzeitgeist/libzeitgeist-2.0.la + +# 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 += diff --git a/doc/libzeitgeist/zeitgeist-2.0-docs.sgml b/doc/libzeitgeist/zeitgeist-2.0-docs.sgml new file mode 100644 index 00000000..61292618 --- /dev/null +++ b/doc/libzeitgeist/zeitgeist-2.0-docs.sgml @@ -0,0 +1,54 @@ +<?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>API Documentation for the Zeitgeist Client Library</title> + </bookinfo> + + <chapter> + <title>Classes</title> + <xi:include href="xml/zeitgeist-event.xml"/> + <xi:include href="xml/zeitgeist-log.xml"/> + <xi:include href="xml/zeitgeist-monitor.xml"/> + <xi:include href="xml/zeitgeist-result-set.xml"/> + <xi:include href="xml/zeitgeist-subject.xml"/> + <xi:include href="xml/zeitgeist-timerange.xml"/> + </chapter> + + <chapter> + <title>Utility Functions</title> + <xi:include href="xml/zeitgeist-mimetypes.xml"/> + <xi:include href="xml/zeitgeist-timestamp.xml"/> + <xi:include href="xml/zeitgeist-symbols.xml"/> + </chapter> + + <chapter> + <title>Enumerations and Macros</title> + <xi:include href="xml/zeitgeist-enums.xml"/> + <xi:include href="xml/zeitgeist-ontology-interpretations.xml"/> + <xi:include href="xml/zeitgeist-ontology-manifestations.xml"/> + </chapter> + + <chapter> + <title>API for Zeitgeist Extensions</title> + <xi:include href="xml/zeitgeist-index.xml"/> + <xi:include href="xml/zeitgeist-data-source.xml"/> + <xi:include href="xml/zeitgeist-data-source-registry.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> |