summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMatthias Vogelgesang <matthias.vogelgesang@kit.edu>2014-10-30 14:43:11 +0100
committerMatthias Vogelgesang <matthias.vogelgesang@kit.edu>2014-10-30 15:14:57 +0100
commit382a245aaa60242a867d7924916b6b9266df15cc (patch)
tree91b8c8c65177ed63227c255652a4411ee4bb9196 /docs
parent46e7d1e1407c6ed1ecd7091ae91743cdba469278 (diff)
Fix building gtk-doc reference
Diffstat (limited to 'docs')
-rw-r--r--docs/Ufo-docs.xml63
-rw-r--r--docs/Ufo-docs.xml.in29
2 files changed, 63 insertions, 29 deletions
diff --git a/docs/Ufo-docs.xml b/docs/Ufo-docs.xml
new file mode 100644
index 0000000..d375ced
--- /dev/null
+++ b/docs/Ufo-docs.xml
@@ -0,0 +1,63 @@
+<?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>UFO Reference Manual</title>
+ <releaseinfo>
+ The latest version of this documentation can be found on-line at
+ <ulink role="online-location" url="http://ufo.kit.edu/ufo">http://ufo.kit.edu/ufo/</ulink>.
+ </releaseinfo>
+ </bookinfo>
+
+ <part>
+ <title>API Reference</title>
+ <chapter id="graphs">
+ <title>Graph structures</title>
+ <xi:include href="xml/ufo-graph.xml"/>
+ <xi:include href="xml/ufo-node.xml"/>
+ </chapter>
+ <chapter id="tasks">
+ <title>Tasks</title>
+ <xi:include href="xml/ufo-plugin-manager.xml"/>
+ <xi:include href="xml/ufo-task-graph.xml"/>
+ <xi:include href="xml/ufo-task-node.xml"/>
+ <xi:include href="xml/ufo-task-iface.xml"/>
+ <xi:include href="xml/ufo-copy-task.xml"/>
+ <xi:include href="xml/ufo-input-task.xml"/>
+ <xi:include href="xml/ufo-output-task.xml"/>
+ </chapter>
+ <chapter id="device_resources">
+ <title>Device Resources</title>
+ <xi:include href="xml/ufo-arch-graph.xml"/>
+ <xi:include href="xml/ufo-cpu-node.xml"/>
+ <xi:include href="xml/ufo-gpu-node.xml"/>
+ <xi:include href="xml/ufo-resources.xml"/>
+ <xi:include href="xml/ufo-buffer.xml"/>
+ <xi:include href="xml/ufo-profiler.xml"/>
+ </chapter>
+ <chapter id="schedulers">
+ <title>Schedulers</title>
+ <xi:include href="xml/ufo-base-scheduler.xml"/>
+ <xi:include href="xml/ufo-scheduler.xml"/>
+ <xi:include href="xml/ufo-fixed-scheduler.xml"/>
+ <xi:include href="xml/ufo-group-scheduler.xml"/>
+ <xi:include href="xml/ufo-local-scheduler.xml"/>
+ </chapter>
+ <chapter id="networking">
+ <title>Networking</title>
+ <xi:include href="xml/ufo-messenger-iface.xml"/>
+ <xi:include href="xml/ufo-zmq-messenger.xml"/>
+ </chapter>
+ </part>
+
+ <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/Ufo-docs.xml.in b/docs/Ufo-docs.xml.in
deleted file mode 100644
index e4bf038..0000000
--- a/docs/Ufo-docs.xml.in
+++ /dev/null
@@ -1,29 +0,0 @@
-<?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>UFO Reference Manual</title>
- <releaseinfo>
- for UFO ${UFO_API_VERSION}
- The latest version of this documentation can be found on-line at
- <ulink role="online-location"
- url="http://ufo.kit.edu/ufo">http://ufo.kit.edu/ufo/</ulink>.
- </releaseinfo>
- </bookinfo>
-
- <chapter>
- <title>UFO API Reference</title>
- ${_xml_doc_input}
-
- </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>