Adding docs.

Original commit message from CVS:
2005-11-30  Julien MOUTTE  <julien@moutte.net>

* docs/libs/gst-plugins-base-libs-docs.sgml:
* docs/libs/gst-plugins-base-libs-sections.txt:
* gst-libs/gst/video/gstvideofilter.c:
* gst-libs/gst/video/gstvideosink.c:
* gst-libs/gst/video/gstvideosink.h: Adding docs.

diff --git a/ChangeLog b/ChangeLog
index acf033374f367513b0c8eac4a71494bba2b0d596..2800f6b67ccaf57ad62969f88afb0d0ab8074bae 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,11 @@
+2005-11-30  Julien MOUTTE  <julien@moutte.net>
+
+       * docs/libs/gst-plugins-base-libs-docs.sgml:
+       * docs/libs/gst-plugins-base-libs-sections.txt:
+       * gst-libs/gst/video/gstvideofilter.c:
+       * gst-libs/gst/video/gstvideosink.c:
+       * gst-libs/gst/video/gstvideosink.h: Adding docs.
+
 2005-11-30  Thomas Vander Stichele  <thomas (at) apestaart (dot) org>
 
        * LICENSE:

diff --git a/docs/libs/gst-plugins-base-libs-docs.sgml b/docs/libs/gst-plugins-base-libs-docs.sgml
index 169416efebb46fc68b6c6f23f5e7d88043aeff1f..736eb3903a64cb711c20a839d4c687d677766a96 100644 (file)
--- a/docs/libs/gst-plugins-base-libs-docs.sgml
+++ b/docs/libs/gst-plugins-base-libs-docs.sgml
@@ -6,6 +6,8 @@
 
 <!ENTITY GstCompiling SYSTEM "compiling.sgml">
 <!ENTITY GstAudio SYSTEM "xml/gstaudio.xml">
+<!ENTITY GstVideoSink SYSTEM "xml/element-videosink.xml">
+<!ENTITY GstVideoFilter SYSTEM "xml/element-videofilter.xml">
 <!ENTITY GstColorBalance SYSTEM "xml/gstcolorbalance.xml">
 <!ENTITY GstGConf SYSTEM "xml/gstgconf.xml">
 <!ENTITY GstMixer SYSTEM "xml/gstmixer.xml">
@@ -39,6 +41,17 @@ This library should be linked to by getting cflags and libs from
     &GstRingBuffer;
   </chapter>
 
+  <chapter id="gstreamer-video">
+    <title>Video Library</title>
+    <para>
+This library should be linked to by getting cflags and libs from
+<filename>gstreamer-plugins-base.pc</filename> and adding
+<filename>-lgstvideo-&GST_MAJORMINOR;</filename> to the library flags.
+    </para>
+    &GstVideoSink;
+    &GstVideoFilter;
+  </chapter>
+
   <chapter id="gstreamer-interfaces">
     <title>Interfaces Library</title>
     <para>

diff --git a/docs/libs/gst-plugins-base-libs-sections.txt b/docs/libs/gst-plugins-base-libs-sections.txt
index e514b89aea1135407423a029c5caa3e24411c3a0..f6558d9e3e678754a39c01ef28edd660e8061512 100644 (file)
--- a/docs/libs/gst-plugins-base-libs-sections.txt
+++ b/docs/libs/gst-plugins-base-libs-sections.txt
@@ -115,3 +115,20 @@ gst_x_overlay_prepare_xwindow_id
 gst_x_overlay_expose
 </SECTION>
 
+<SECTION>
+<FILE>element-videosink</FILE>
+<INCLUDE>gst/video/gstvideosink.h</INCLUDE>
+GstVideoSink
+GstVideoSinkClass
+GstVideoRectangle
+gst_video_sink_center_rect
+</SECTION>
+
+<SECTION>
+<FILE>element-videofilter</FILE>
+<INCLUDE>gst/video/gstvideofilter.h</INCLUDE>
+GstVideoFilter
+GstVideoFilterClass
+</SECTION>
+
+

diff --git a/gst-libs/gst/video/gstvideofilter.c b/gst-libs/gst/video/gstvideofilter.c
index 686ebbaf3ab9d3a5fb5c297645e6deab583b29b9..6899b5363cbf4cdd7b663f647928297ae122e670 100644 (file)
--- a/gst-libs/gst/video/gstvideofilter.c
+++ b/gst-libs/gst/video/gstvideofilter.c
@@ -18,6 +18,18 @@
  * Boston, MA 02111-1307, USA.
  */
 
+ /**
+ * SECTION:element-videofilter
+ * @short_description: Base class for video filters.
+ * 
+ * <refsect2>
+ * <para>
+ * Provides useful functions and a base class for video filters. Right now it's 
+ * mostly used as a place holder for adding common code later on.
+ * </para>
+ * </refsect2>
+ */
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif

diff --git a/gst-libs/gst/video/gstvideosink.c b/gst-libs/gst/video/gstvideosink.c
index 71a71f5e3d7c9bc4da12a8422a6cd061422063da..39075c1d23fbb56d86af3f8776906cc49edb0840 100644 (file)
--- a/gst-libs/gst/video/gstvideosink.c
+++ b/gst-libs/gst/video/gstvideosink.c
@@ -19,6 +19,18 @@
  * Boston, MA 02111-1307, USA.
  */
 
+/**
+ * SECTION:element-videosink
+ * @short_description: Base class for video sinks.
+ * 
+ * <refsect2>
+ * <para>
+ * Provides useful functions and a base class for video sinks. Right now it's 
+ * mostly used as a place holder for adding common code later on.
+ * </para>
+ * </refsect2>
+ */
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
@@ -27,6 +39,17 @@
 
 static GstElementClass *parent_class = NULL;
 
+/**
+ * gst_video_sink_center_rect:
+ * @src: the #GstVideoRectangle describing the source area
+ * @dst: the #GstVideoRectangle describing the destination area
+ * @result: a pointer to a #GstVideoRectangle which will receive the result area
+ * @scaling: a #gboolean indicating if scaling should be applied or not
+ * 
+ * Takes @src rectangle and position it at the center of @dst rectangle with or
+ * without @scaling. It handles clipping if the @src rectangle is bigger than
+ * the @dst one and @scaling is set to FALSE.
+ */
 void
 gst_video_sink_center_rect (GstVideoRectangle src, GstVideoRectangle dst,
     GstVideoRectangle * result, gboolean scaling)

diff --git a/gst-libs/gst/video/gstvideosink.h b/gst-libs/gst/video/gstvideosink.h
index 49f5522d33462fd96fccddd84bd7a9619921500d..4cd36a3b79587356804eb12097aa42ceae9f099d 100644 (file)
--- a/gst-libs/gst/video/gstvideosink.h
+++ b/gst-libs/gst/video/gstvideosink.h
@@ -48,6 +48,15 @@ typedef struct _GstVideoSink GstVideoSink;
 typedef struct _GstVideoSinkClass GstVideoSinkClass;
 typedef struct _GstVideoRectangle GstVideoRectangle;
 
+/**
+ * GstVideoRectangle:
+ * @x: X coordinate of rectangle's top-left point
+ * @y: Y coordinate of rectangle's top-left point
+ * @w: width of the rectangle
+ * @h: height of the rectangle
+ *
+ * Helper structure representing a rectangular area.
+ */
 struct _GstVideoRectangle {
   gint x;
   gint y;