docs: add GstVideoPool to docs
authorTim-Philipp Müller <tim@centricular.com>
Fri, 21 Feb 2014 19:28:55 +0000 (19:28 +0000)
committerTim-Philipp Müller <tim@centricular.com>
Sun, 23 Feb 2014 14:42:12 +0000 (14:42 +0000)
docs/libs/gst-plugins-base-libs-docs.sgml
docs/libs/gst-plugins-base-libs-sections.txt
gst-libs/gst/video/gstvideopool.c

index 734c46a..fedb377 100644 (file)
       <xi:include href="xml/gstvideooverlay.xml" />
       <xi:include href="xml/gstvideodecoder.xml" />
       <xi:include href="xml/gstvideoencoder.xml" />
+      <xi:include href="xml/gstvideopool.xml" />
       <xi:include href="xml/gstvideoutils.xml" />
     </chapter>
   </part>
index d8498a4..4ddd44b 100644 (file)
@@ -2337,6 +2337,7 @@ GST_TYPE_NAVIGATION_EVENT_TYPE
 
 <SECTION>
 <FILE>gstvideopool</FILE>
+<TITLE>GstVideoPool</TITLE>
 <INCLUDE>gst/video/gstvideopool.h</INCLUDE>
 GstVideoBufferPool
 GstVideoBufferPoolClass
index 63d2a2c..4475f45 100644 (file)
 #include "gst/video/gstvideopool.h"
 
 /**
+ * SECTION:gstvideopool
+ * @short_description: GstBufferPool for raw video buffers
+ * @see_also: #GstBufferPool
+ *
+ * Special GstBufferPool subclass for raw video buffers.
+ *
+ * Allows configuration of video-specific requirements such as
+ * stride alignments or pixel padding, and can also be configured
+ * to automatically add #GstVideoMeta to the buffers.
+ */
+
+/**
  * gst_buffer_pool_config_set_video_alignment:
  * @config: a #GstStructure
  * @align: a #GstVideoAlignment