[cheese/three-point-oh] add gtk-doc documentation support to libcheese

[Daniel G. Siegel <dgsiegel src gnome org>]

commit 5510c189d4bee2fa32c04a22801db656930699bd
Author: daniel g. siegel <dgsiegel gnome org>
Date:   Mon Jul 12 20:45:10 2010 +0200

    add gtk-doc documentation support to libcheese
    
    attention: the api sucks and so does the documentation,
    please use at your own risk

 Makefile.am                        |    2 +-
 autogen.sh                         |    2 +
 configure.ac                       |    2 +-
 docs/reference/Makefile.am         |    2 +-
 docs/reference/cheese-docs.xml     |   43 ++++++++++++++++++++++
 docs/reference/cheese-sections.txt |   70 ++++++++++++++++++++++++++++++++++++
 docs/reference/cheese.types        |    4 ++
 7 files changed, 122 insertions(+), 3 deletions(-)
---
diff --git a/Makefile.am b/Makefile.am
index 935778a..e5af844 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -1,4 +1,4 @@
-SUBDIRS = libcheese src tests po data help docs 
+SUBDIRS = libcheese src tests po data help docs
 
 EXTRA_DIST =			\
 	$(cheesedoc_DATA)	\
diff --git a/autogen.sh b/autogen.sh
index cce7341..8baf22a 100755
--- a/autogen.sh
+++ b/autogen.sh
@@ -17,6 +17,8 @@ which gnome-autogen.sh || {
     exit 1
 }
 
+gtkdocize || exit 1
+
 REQUIRED_AUTOCONF_VERSION=2.57
 REQUIRED_AUTOMAKE_VERSION=1.7
 REQUIRED_INTLTOOL_VERSION=0.40.0
diff --git a/configure.ac b/configure.ac
index 08c4bd5..c06e885 100644
--- a/configure.ac
+++ b/configure.ac
@@ -24,7 +24,7 @@ CFLAGS+=" -DGSEAL_ENABLE"
 GNOME_MAINTAINER_MODE_DEFINES
 GNOME_COMPILE_WARNINGS
 
-GTK_DOC_CHECK(1.11)
+GTK_DOC_CHECK([1.14],[--flavour no-tmpl])
 
 #*******************************************************************************
 # soname
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
index 541d39e..1fb5f41 100644
--- a/docs/reference/Makefile.am
+++ b/docs/reference/Makefile.am
@@ -25,7 +25,7 @@ SCANGOBJ_OPTIONS=
 
 # Extra options to supply to gtkdoc-scan.
 # e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED" 
-SCAN_OPTIONS=
+SCAN_OPTIONS=--rebuild-types
 
 # Extra options to supply to gtkdoc-mkdb.
 # e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
diff --git a/docs/reference/cheese-docs.xml b/docs/reference/cheese-docs.xml
new file mode 100644
index 0000000..2246d6e
--- /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>
diff --git a/docs/reference/cheese-sections.txt b/docs/reference/cheese-sections.txt
new file mode 100644
index 0000000..11153da
--- /dev/null
+++ b/docs/reference/cheese-sections.txt
@@ -0,0 +1,70 @@
+<SECTION>
+<FILE>cheese-widget</FILE>
+<TITLE>CheeseWidget</TITLE>
+CheeseWidgetClass
+CheeseWidget
+cheese_widget_new
+cheese_widget_get_error
+CheeseWidgetState
+<SUBSECTION Standard>
+CHEESE_WIDGET
+CHEESE_IS_WIDGET
+CHEESE_TYPE_WIDGET
+cheese_widget_get_type
+CHEESE_WIDGET_CLASS
+CHEESE_IS_WIDGET_CLASS
+CHEESE_WIDGET_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>cheese-effect</FILE>
+<TITLE>CheeseEffect</TITLE>
+CheeseEffect
+CheeseEffectClass
+cheese_effect_new
+cheese_effect_enable_preview
+cheese_effect_disable_preview
+<SUBSECTION Standard>
+CHEESE_EFFECT
+CHEESE_IS_EFFECT
+CHEESE_TYPE_EFFECT
+cheese_effect_get_type
+CHEESE_EFFECT_CLASS
+CHEESE_IS_EFFECT_CLASS
+CHEESE_EFFECT_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>cheese-camera-device-monitor</FILE>
+<TITLE>CheeseCameraDeviceMonitor</TITLE>
+CheeseCameraDeviceMonitorClass
+CheeseCameraDeviceMonitor
+cheese_camera_device_monitor_new
+cheese_camera_device_monitor_coldplug
+<SUBSECTION Standard>
+CHEESE_CAMERA_DEVICE_MONITOR
+CHEESE_IS_CAMERA_DEVICE_MONITOR
+CHEESE_TYPE_CAMERA_DEVICE_MONITOR
+cheese_camera_device_monitor_get_type
+CHEESE_CAMERA_DEVICE_MONITOR_CLASS
+CHEESE_IS_CAMERA_DEVICE_MONITOR_CLASS
+CHEESE_CAMERA_DEVICE_MONITOR_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>cheese-avatar-chooser</FILE>
+<TITLE>CheeseAvatarChooser</TITLE>
+CheeseAvatarChooserClass
+CheeseAvatarChooser
+cheese_avatar_chooser_new
+cheese_avatar_chooser_get_picture
+<SUBSECTION Standard>
+CHEESE_AVATAR_CHOOSER
+CHEESE_IS_AVATAR_CHOOSER
+CHEESE_TYPE_AVATAR_CHOOSER
+cheese_avatar_chooser_get_type
+CHEESE_AVATAR_CHOOSER_CLASS
+CHEESE_IS_AVATAR_CHOOSER_CLASS
+CHEESE_AVATAR_CHOOSER_GET_CLASS
+</SECTION>
+
diff --git a/docs/reference/cheese.types b/docs/reference/cheese.types
new file mode 100644
index 0000000..ab80c99
--- /dev/null
+++ b/docs/reference/cheese.types
@@ -0,0 +1,4 @@
+cheese_avatar_chooser_get_type
+cheese_camera_device_monitor_get_type
+cheese_effect_get_type
+cheese_widget_get_type