Add more classes to gtk-doc documentation

Add basic documentation for CheeseCamera, CheeseFileUtil and CheeseFlash
classes. Split the API reference into libcheese and libcheese-gtk
chapters.

4 files changed, 134 insertions, 55 deletions

diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
index 26b933db..d5eefda6 100644
--- a/docs/reference/Makefile.am
+++ b/docs/reference/Makefile.am
@@ -50,12 +50,8 @@ CFILE_GLOB=$(top_srcdir)/libcheese/*.c
 
 # Header files to ignore when scanning.
 # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
-IGNORE_HFILES=					\
-	cheese-camera.h				\
-	cheese-aspect-frame.h			\
-	cheese-fileutil.h			\
-	cheese-flash.h				\
-	cheese-widget-private.h			\
+IGNORE_HFILES= \
+	cheese-aspect-frame.h \
 	cheese-enums.h \
 	um-crop-area.h
 
@@ -77,9 +73,8 @@ expand_content_files=
 # signals and properties.
 # e.g. AM_CPPFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
 # e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
-AM_CPPFLAGS=-I$(top_srcdir) -I$(top_builddir) $(CHEESE_CFLAGS)
-GTKDOC_LIBS=\
-	$(CHEESE_LIBS) \
+AM_CFLAGS = $(CHEESE_CFLAGS)
+GTKDOC_LIBS = \
 	$(top_builddir)/libcheese.la \
 	$(top_builddir)/libcheese-gtk.la
 
@@ -93,3 +88,6 @@ include $(top_srcdir)/gtk-doc.make
 #TESTS_ENVIRONMENT = cd $(srcdir) &&
 #TESTS = $(GTKDOC_CHECK)
 #endif
+
+sgml.stamp: $(DOC_MODULE)-sections.txt
+$(DOC_MAIN_SGML_FILE): sgml.stamp
diff --git a/docs/reference/cheese-docs.xml b/docs/reference/cheese-docs.xml
index a3976036..4face42f 100644
--- a/docs/reference/cheese-docs.xml
+++ b/docs/reference/cheese-docs.xml
@@ -19,15 +19,33 @@
     <title>Cheese Overview</title>
     <para>
     Cheese uses your webcam to take photos and videos, applies fancy special
-    effects and lets you share the fun with others
+    effects and lets you share the fun with others. Cheese also provides two
+    libraries for use by other applications: libcheese and libcheese-gtk.
     </para>
+  </chapter>
 
-    <xi:include href="xml/cheese-widget.xml"/>
-    <xi:include href="xml/cheese-effect.xml"/>
+  <chapter>
+    <title>libcheese</title>
+    <para>
+    libcheese provides video and photo capture functionality which does not
+    require GTK+, such as enumerating video capture devices.
+    </para>
+    <xi:include href="xml/cheese-camera.xml"/>
     <xi:include href="xml/cheese-camera-device.xml"/>
     <xi:include href="xml/cheese-camera-device-monitor.xml"/>
-    <xi:include href="xml/cheese-avatar-chooser.xml"/>
+    <xi:include href="xml/cheese-effect.xml"/>
+    <xi:include href="xml/cheese-file-util.xml"/>
+  </chapter>
 
+  <chapter>
+    <title>libcheese-gtk</title>
+    <para>
+    libcheese-gtk provides video and photo capture widgets for use in GTK+
+    applications
+    </para>
+    <xi:include href="xml/cheese-avatar-chooser.xml"/>
+    <xi:include href="xml/cheese-flash.xml"/>
+    <xi:include href="xml/cheese-widget.xml"/>
   </chapter>
 
   <chapter id="object-tree">
diff --git a/docs/reference/cheese-sections.txt b/docs/reference/cheese-sections.txt
index 18fc322d..dc931485 100644
--- a/docs/reference/cheese-sections.txt
+++ b/docs/reference/cheese-sections.txt
@@ -1,44 +1,43 @@
 <SECTION>
-<FILE>cheese-widget</FILE>
-<TITLE>CheeseWidget</TITLE>
-CheeseWidgetClass
-CheeseWidget
-cheese_widget_new
-cheese_widget_get_error
-CheeseWidgetState
+<FILE>cheese-avatar-chooser</FILE>
+<TITLE>CheeseAvatarChooser</TITLE>
+CheeseAvatarChooserClass
+CheeseAvatarChooser
+cheese_avatar_chooser_new
+cheese_avatar_chooser_get_picture
 <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
+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>
 
 <SECTION>
-<FILE>cheese-effect</FILE>
-<TITLE>CheeseEffect</TITLE>
-CheeseEffect
-CheeseEffectClass
-cheese_effect_new
-cheese_effect_enable_preview
-cheese_effect_disable_preview
+<FILE>cheese-camera</FILE>
+<TITLE>CheeseCamera</TITLE>
+CheeseCameraClass
+CheeseCamera
+cheese_camera_new
+cheese_camera_setup
+CheeseCameraError
 <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
+CHEESE_CAMERA
+CHEESE_IS_CAMERA
+CHEESE_TYPE_CAMERA
+cheese_camera_get_type
+CHEESE_CAMERA_CLASS
+CHEESE_IS_CAMERA_CLASS
+CHEESE_CAMERA_GET_CLASS
 </SECTION>
 
 <SECTION>
 <FILE>cheese-camera-device</FILE>
 <TITLE>CheeseCameraDevice</TITLE>
-CheeseCameraDevice
 CheeseCameraDeviceClass
+CheeseCameraDevice
 cheese_camera_device_new
 cheese_camera_device_get_name
 cheese_camera_device_get_id
@@ -71,19 +70,80 @@ 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
+<FILE>cheese-effect</FILE>
+<TITLE>CheeseEffect</TITLE>
+CheeseEffectClass
+CheeseEffect
+cheese_effect_new
+cheese_effect_enable_preview
+cheese_effect_disable_preview
 <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
+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-file-util</FILE>
+<TITLE>CheeseFileUtil</TITLE>
+CheeseFileUtilClass
+CheeseFileUtil
+cheese_fileutil_new
+CHEESE_PHOTO_NAME_SUFFIX
+CHEESE_VIDEO_NAME_SUFFIX
+CheeseMediaMode
+cheese_fileutil_get_new_media_filename
+cheese_fileutil_get_path_before_224
+cheese_fileutil_get_photo_path
+cheese_fileutil_get_video_path
+cheese_fileutil_reset_burst
+<SUBSECTION Standard>
+CHEESE_FILEUTIL
+CHEESE_IS_FILEUTIL
+CHEESE_TYPE_FILEUTIL
+cheese_fileutil_get_type
+CHEESE_FILEUTIL_CLASS
+CHEESE_IS_FILEUTIL_CLASS
+CHEESE_FILEUTIL_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>cheese-flash</FILE>
+<TITLE>CheeseFlash</TITLE>
+CheeseFlashClass
+CheeseFlash
+cheese_flash_new
+cheese_flash_fire
+<SUBSECTION Standard>
+CHEESE_FLASH
+CHEESE_IS_FLASH
+CHEESE_TYPE_FLASH
+cheese_flash_get_type
+CHEESE_FLASH_CLASS
+CHEESE_IS_FLASH_CLASS
+CHEESE_FLASH_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>cheese-widget</FILE>
+<TITLE>CheeseWidget</TITLE>
+CheeseWidgetClass
+CheeseWidget
+cheese_widget_new
+cheese_widget_get_camera
+cheese_widget_get_error
+cheese_widget_get_video_area
+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>
diff --git a/docs/reference/cheese.types b/docs/reference/cheese.types
index f1800cbf..c8803fd4 100644
--- a/docs/reference/cheese.types
+++ b/docs/reference/cheese.types
@@ -1,6 +1,9 @@
 cheese_avatar_chooser_get_type
 cheese_camera_device_get_type
 cheese_camera_device_monitor_get_type
+cheese_camera_get_type
 cheese_effect_get_type
+cheese_fileutil_get_type
+cheese_flash_get_type
 cheese_video_format_get_type
 cheese_widget_get_type