From 53db4a18849d037b1852488ffa3ed8e162cb44e8 Mon Sep 17 00:00:00 2001
From: Stefan Kost <ensonic@users.sf.net>
Date: Wed, 24 Mar 2010 16:15:37 +0200
Subject: [PATCH] docs: add photography iface to docs

We normaly have separate libs docs, not done becasue of lazyness here yet.
---
 docs/plugins/Makefile.am                      |  3 +-
 .../plugins/gst-plugins-bad-plugins-docs.sgml |  5 +++
 .../gst-plugins-bad-plugins-sections.txt      | 45 +++++++++++++++++++
 docs/plugins/gst-plugins-bad-plugins.types    |  5 +++
 gst-libs/gst/interfaces/photography.c         | 11 +++--
 5 files changed, 65 insertions(+), 4 deletions(-)

diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am
index a5bab1d036..7c01239682 100644
--- a/docs/plugins/Makefile.am
+++ b/docs/plugins/Makefile.am
@@ -166,7 +166,8 @@ EXTRA_HFILES = \
 	$(top_srcdir)/gst/videosignal/gstvideomark.h \
 	$(top_srcdir)/gst/valve/gstvalve.h \
 	$(top_srcdir)/sys/directdraw/gstdirectdrawsink.h \
-	$(top_srcdir)/sys/dvb/gstdvbsrc.h
+	$(top_srcdir)/sys/dvb/gstdvbsrc.h \
+	$(top_srcdir)/gst-libs/gst/interfaces/photography.h
 
 # Images to copy into HTML directory.
 HTML_IMAGES = $(srcdir)/figures/*.png
diff --git a/docs/plugins/gst-plugins-bad-plugins-docs.sgml b/docs/plugins/gst-plugins-bad-plugins-docs.sgml
index 228fe1ba14..81c1dde1ab 100644
--- a/docs/plugins/gst-plugins-bad-plugins-docs.sgml
+++ b/docs/plugins/gst-plugins-bad-plugins-docs.sgml
@@ -184,4 +184,9 @@
     <title>gst-plugins-bad Classes</title>
     <xi:include href="xml/gstbasemetadata.xml" />
   </chapter>
+
+  <chapter>
+    <title>gst-plugins-bad Interfaces</title>
+    <xi:include href="xml/gstphotography.xml" />
+  </chapter>
 </book>
diff --git a/docs/plugins/gst-plugins-bad-plugins-sections.txt b/docs/plugins/gst-plugins-bad-plugins-sections.txt
index f0d200b87c..f8da17e007 100644
--- a/docs/plugins/gst-plugins-bad-plugins-sections.txt
+++ b/docs/plugins/gst-plugins-bad-plugins-sections.txt
@@ -1184,3 +1184,48 @@ GST_IS_ZBAR_CLASS
 GST_TYPE_ZBAR
 </SECTION>
 
+# gst-libs
+
+<SECTION>
+<FILE>gstphotography</FILE>
+<TITLE>GstPhotography</TITLE>
+GstPhotography
+GstWhiteBalanceMode
+GstColourToneMode
+GstSceneMode
+GstFlashMode
+GstFocusStatus
+GstPhotoCaps
+GstPhotoShakeRisk
+GstPhotoSettings
+GstPhotoCapturePrepared
+gst_photography_get_ev_compensation
+gst_photography_get_iso_speed
+gst_photography_get_aperture
+gst_photography_get_exposure
+gst_photography_get_white_balance_mode
+gst_photography_get_colour_tone_mode
+gst_photography_get_scene_mode
+gst_photography_get_flash_mode
+gst_photography_get_zoom
+gst_photography_set_ev_compensation
+gst_photography_set_iso_speed
+gst_photography_set_aperture
+gst_photography_set_exposure
+gst_photography_set_white_balance_mode
+gst_photography_set_colour_tone_mode
+gst_photography_set_scene_mode
+gst_photography_set_flash_mode
+gst_photography_set_zoom
+gst_photography_get_capabilities
+gst_photography_prepare_for_capture
+gst_photography_set_autofocus
+gst_photography_set_config
+gst_photography_get_config
+<SUBSECTION Standard>
+GST_PHOTOGRAPHY
+GST_IS_PHOTOGRAPHY
+GST_PHOTOGRAPHY_GET_IFACE
+gst_photography_get_type
+</SECTION>
+
diff --git a/docs/plugins/gst-plugins-bad-plugins.types b/docs/plugins/gst-plugins-bad-plugins.types
index 9f4950e70d..3117ba5d71 100644
--- a/docs/plugins/gst-plugins-bad-plugins.types
+++ b/docs/plugins/gst-plugins-bad-plugins.types
@@ -1 +1,6 @@
 #include <gst/gst.h>
+
+#include <gst/interfaces/photography.h>
+
+gst_photography_get_type
+
diff --git a/gst-libs/gst/interfaces/photography.c b/gst-libs/gst/interfaces/photography.c
index a793aecb6e..29c3996ff5 100644
--- a/gst-libs/gst/interfaces/photography.c
+++ b/gst-libs/gst/interfaces/photography.c
@@ -28,10 +28,15 @@
 #include "photography.h"
 
 /**
- * SECTION:photography
- * @short_description: Interface for elements having digital imaging controls
+ * SECTION:gstphotography
+ * @short_description: Interface for digital image capture elements
  *
- * The interface allows access to some common digital imaging controls
+ * The interface allows access to some common digital image capture parameters.
+ *
+ * <note>
+ *   The GstPhotography interface is unstable API and may change in future.
+ *   One can define GST_USE_UNSTABLE_API to acknowledge and avoid this warning.
+ * </note>
  */
 
 static void gst_photography_iface_base_init (GstPhotographyInterface * iface);