From 0fac936525b1ff8933414d49a88d64ca3820d88f Mon Sep 17 00:00:00 2001
From: Edward Hervey <bilboed@bilboed.com>
Date: Mon, 20 Sep 2010 11:23:17 +0200
Subject: [PATCH] docs: Documentation for new pbutils GstDiscoverer

Fixes #625944
---
 docs/libs/Makefile.am                        |  5 +-
 docs/libs/gst-plugins-base-libs-docs.sgml    | 10 ++
 docs/libs/gst-plugins-base-libs-sections.txt | 96 ++++++++++++++++++++
 docs/libs/gst-plugins-base-libs.types        |  2 +
 4 files changed, 111 insertions(+), 2 deletions(-)

diff --git a/docs/libs/Makefile.am b/docs/libs/Makefile.am
index d031626866..5c79bf6f45 100644
--- a/docs/libs/Makefile.am
+++ b/docs/libs/Makefile.am
@@ -75,10 +75,11 @@ SCANOBJ_DEPS = \
 	$(top_builddir)/gst-libs/gst/sdp/libgstsdp-@GST_MAJORMINOR@.la \
 	$(top_builddir)/gst-libs/gst/tag/libgsttag-@GST_MAJORMINOR@.la \
 	$(top_builddir)/gst-libs/gst/video/libgstvideo-@GST_MAJORMINOR@.la \
-	$(top_builddir)/gst-libs/gst/app/libgstapp-@GST_MAJORMINOR@.la
+	$(top_builddir)/gst-libs/gst/app/libgstapp-@GST_MAJORMINOR@.la \
+	$(top_builddir)/gst-libs/gst/pbutils/libgstpbutils-@GST_MAJORMINOR@.la
 
 # Header files to ignore when scanning.
-IGNORE_HFILES =
+IGNORE_HFILES = gstdiscoverer-private.h
 
 # Images to copy into HTML directory.
 HTML_IMAGES =
diff --git a/docs/libs/gst-plugins-base-libs-docs.sgml b/docs/libs/gst-plugins-base-libs-docs.sgml
index db56ded255..64885ec898 100644
--- a/docs/libs/gst-plugins-base-libs-docs.sgml
+++ b/docs/libs/gst-plugins-base-libs-docs.sgml
@@ -217,6 +217,16 @@
       <xi:include href="xml/gstvideofilter.xml" />
       <xi:include href="xml/gstvideosink.xml" />
     </chapter>
+
+    <chapter id="gstreamer-discoverer">
+      <title>Discoverer Library</title>
+      <para>
+        This library should be linked to by getting cflags and libs from
+        <filename>gstreamer-plugins-base-&GST_MAJORMINOR;.pc</filename> and adding
+        <filename>-lgstdiscoverer-&GST_MAJORMINOR;</filename> to the library flags.
+      </para>
+      <xi:include href="xml/gstdiscoverer.xml" />
+    </chapter>
   </part>
 
   <part id="gstreamer-libs-hierarchy">
diff --git a/docs/libs/gst-plugins-base-libs-sections.txt b/docs/libs/gst-plugins-base-libs-sections.txt
index 9d0d55ad28..310a74e48d 100644
--- a/docs/libs/gst-plugins-base-libs-sections.txt
+++ b/docs/libs/gst-plugins-base-libs-sections.txt
@@ -1938,6 +1938,102 @@ GST_IS_VIDEO_SINK_CLASS
 gst_video_sink_get_type
 </SECTION>
 
+<SECTION>
+<FILE>gstdiscoverer</FILE>
+<INCLUDE>gst/pbutils/pbutils.h</INCLUDE>
+<SUBSECTION>
+GstDiscoverer
+gst_discoverer_new
+gst_discoverer_start
+gst_discoverer_stop
+gst_discoverer_discover_uri
+gst_discoverer_discover_uri_async
+<SUBSECTION>
+GstDiscovererInfo
+GstDiscovererResult
+gst_discoverer_info_get_duration
+gst_discoverer_info_get_misc
+gst_discoverer_info_get_result
+gst_discoverer_info_get_stream_info
+gst_discoverer_info_get_stream_list
+gst_discoverer_info_get_tags
+gst_discoverer_info_get_uri
+gst_discoverer_info_unref
+<SUBSECTION>
+GstDiscovererStreamInfo
+GstDiscovererContainerInfo
+GstDiscovererAudioInfo
+GstDiscovererVideoInfo
+gst_discoverer_stream_info_get_caps
+gst_discoverer_stream_info_get_misc
+gst_discoverer_stream_info_get_next
+gst_discoverer_stream_info_get_previous
+gst_discoverer_stream_info_get_tags
+gst_discoverer_stream_info_ref
+gst_discoverer_stream_info_unref
+gst_discoverer_stream_info_list_free
+gst_discoverer_stream_info_get_stream_type_nick
+gst_discoverer_info_copy
+gst_discoverer_info_ref
+gst_discoverer_info_get_audio_streams
+gst_discoverer_info_get_container_streams
+gst_discoverer_info_get_streams
+gst_discoverer_info_get_video_streams
+gst_discoverer_audio_info_get_bitrate
+gst_discoverer_audio_info_get_channels
+gst_discoverer_audio_info_get_depth
+gst_discoverer_audio_info_get_max_bitrate
+gst_discoverer_audio_info_get_sample_rate
+gst_discoverer_container_info_get_streams
+gst_discoverer_video_info_get_bitrate
+gst_discoverer_video_info_get_depth
+gst_discoverer_video_info_get_framerate_denom
+gst_discoverer_video_info_get_framerate_num
+gst_discoverer_video_info_get_height
+gst_discoverer_video_info_get_interlaced
+gst_discoverer_video_info_get_is_image
+gst_discoverer_video_info_get_max_bitrate
+gst_discoverer_video_info_get_par_denom
+gst_discoverer_video_info_get_par_num
+gst_discoverer_video_info_get_width
+<SUBSECTION Standard>
+GST_DISCOVERER
+GST_DISCOVERER_AUDIO_INFO
+GST_DISCOVERER_CLASS
+GST_DISCOVERER_CONTAINER_INFO
+GST_DISCOVERER_INFO
+GST_DISCOVERER_STREAM_INFO
+GST_DISCOVERER_VIDEO_INFO
+GST_IS_DISCOVERER
+GST_IS_DISCOVERER_INFO
+GST_IS_DISCOVERER_AUDIO_INFO
+GST_IS_DISCOVERER_CLASS
+GST_IS_DISCOVERER_CONTAINER_INFO
+GST_IS_DISCOVERER_STREAM_INFO
+GST_IS_DISCOVERER_VIDEO_INFO
+GST_TYPE_DISCOVERER
+GST_TYPE_DISCOVERER_AUDIO_INFO
+GST_TYPE_DISCOVERER_CONTAINER_INFO
+GST_TYPE_DISCOVERER_INFO
+GST_TYPE_DISCOVERER_RESULT
+GST_TYPE_DISCOVERER_STREAM_INFO
+GST_TYPE_DISCOVERER_VIDEO_INFO
+GstDiscovererAudioInfoClass
+GstDiscovererClass
+GstDiscovererContainerInfoClass
+GstDiscovererPrivate
+GstDiscovererStreamInfoClass
+GstDiscovererVideoInfoClass
+GstDiscovererInfoClass
+gst_discoverer_audio_info_get_type
+gst_discoverer_container_info_get_type
+gst_discoverer_get_type
+gst_discoverer_info_get_type
+gst_discoverer_result_get_type
+gst_discoverer_stream_info_get_type
+gst_discoverer_video_info_get_type
+</SECTION>
+
 # private
 
 <SECTION>
diff --git a/docs/libs/gst-plugins-base-libs.types b/docs/libs/gst-plugins-base-libs.types
index 85866a84eb..db3818a1d3 100644
--- a/docs/libs/gst-plugins-base-libs.types
+++ b/docs/libs/gst-plugins-base-libs.types
@@ -57,3 +57,5 @@ gst_video_filter_get_type
 #include <gst/video/gstvideosink.h>
 gst_video_sink_get_type
 
+#include <gst/pbutils/pbutils.h>
+gst_discoverer_get_type