summaryrefslogtreecommitdiff
path: root/docs/reference/cheese-docs.xml
diff options
context:
space:
mode:
authordaniel g. siegel <dgsiegel@gnome.org>2010-07-12 20:45:10 +0200
committerdaniel g. siegel <dgsiegel@gnome.org>2010-07-13 00:04:44 +0200
commit5510c189d4bee2fa32c04a22801db656930699bd (patch)
tree3f61f4132663db6df36d6e870c6b8cde35f4fd80 /docs/reference/cheese-docs.xml
parent89f3a695fe698561f1999048107376cecc2679df (diff)
downloadcheese-5510c189d4bee2fa32c04a22801db656930699bd.tar.gz
add gtk-doc documentation support to libcheese
attention: the api sucks and so does the documentation, please use at your own risk
Diffstat (limited to 'docs/reference/cheese-docs.xml')
-rw-r--r--docs/reference/cheese-docs.xml43
1 files changed, 43 insertions, 0 deletions
diff --git a/docs/reference/cheese-docs.xml b/docs/reference/cheese-docs.xml
new file mode 100644
index 00000000..2246d6e0
--- /dev/null
+++ b/docs/reference/cheese-docs.xml
@@ -0,0 +1,43 @@
+<?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>Cheese Reference Manual</title>
+ <releaseinfo>
+ for cheese &version;.
+ The latest version of this documentation can be found on-line at
+ <ulink role="online-location" url="http://[SERVER]/cheese/index.html">http://[SERVER]/cheese/</ulink>.
+ <ulink role="online-location" url="http://library.gnome.org/devel/cheese/unstable/">http://library.gnome.org/devel/cheese/unstable/</ulink>.
+ </releaseinfo>
+ </bookinfo>
+
+ <chapter>
+ <title>Cheese Overview</title>
+ <partintro>
+ <para>
+ Cheese uses your webcam to take photos and videos, applies fancy special
+ effects and lets you share the fun with others
+ </para>
+ </partintro>
+
+ <xi:include href="xml/cheese-widget.xml"/>
+ <xi:include href="xml/cheese-effect.xml"/>
+ <xi:include href="xml/cheese-camera-device-monitor.xml"/>
+ <xi:include href="xml/cheese-avatar-chooser.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>