summaryrefslogtreecommitdiff
path: root/docs/reference/endless/endless-docs.xml
diff options
context:
space:
mode:
authorPhilip Chimento <philip@endlessm.com>2013-04-10 11:42:03 +0100
committerP. F. Chimento <philip.chimento@gmail.com>2013-04-17 17:15:52 +0200
commit6347c78610a7197e1d0cedd1a4a2136a595b5a67 (patch)
tree5eb4b408c6858fcff0b26b17d278682fabcdcb33 /docs/reference/endless/endless-docs.xml
parent5049b8938f407629690c6682263187986fb5f2ba (diff)
Autogenerate documentation with Gtk-doc
Run './configure --enable-gtk-doc' to turn on building documentation, or use --disable-gtk-doc to disable it (for faster builds.) It builds as part of the regular 'make' invocation, though you can use 'make docs' to build only the documentation. [#1]
Diffstat (limited to 'docs/reference/endless/endless-docs.xml')
-rw-r--r--docs/reference/endless/endless-docs.xml39
1 files changed, 39 insertions, 0 deletions
diff --git a/docs/reference/endless/endless-docs.xml b/docs/reference/endless/endless-docs.xml
new file mode 100644
index 0000000..d4004aa
--- /dev/null
+++ b/docs/reference/endless/endless-docs.xml
@@ -0,0 +1,39 @@
+<?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'">
+ <!ENTITY version SYSTEM "version.xml">
+]>
+<book id="index">
+ <bookinfo>
+ <title>Open Endless SDK reference (C API)</title>
+ <releaseinfo>
+ <para>Version: &version;</para>
+ <!--The latest version of this documentation can be found on-line at
+ <ulink role="online-location" url="http://[SERVER]/endless/index.html">http://[SERVER]/endless/</ulink>.-->
+ </releaseinfo>
+ </bookinfo>
+
+ <chapter>
+ <title>Open Endless SDK reference (C API)</title>
+ <xi:include href="xml/hello.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>
+
+ <index id="deprecated-api-index" role="deprecated">
+ <title>Index of deprecated API</title>
+ <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
+ </index>
+
+ <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
+</book>