docs: add fdmemory to docs
authorStefan Sauer <ensonic@users.sf.net>
Mon, 18 May 2015 18:56:28 +0000 (20:56 +0200)
committerStefan Sauer <ensonic@users.sf.net>
Mon, 18 May 2015 18:56:28 +0000 (20:56 +0200)
docs/libs/gst-plugins-base-libs-docs.sgml
docs/libs/gst-plugins-base-libs-sections.txt
gst-libs/gst/allocators/gstfdmemory.c
gst-libs/gst/allocators/gstfdmemory.h

index 865ee29..7767abf 100644 (file)
@@ -29,6 +29,7 @@
         <filename>-lgstallocators-&GST_API_VERSION;</filename> to the library flags.
       </para>
       <xi:include href="xml/gstdmabuf.xml" />
+      <xi:include href="xml/gstfdmemory.xml" />
     </chapter>
 
     <chapter id="gstreamer-app">
index e4352c7..3228be1 100644 (file)
@@ -4,6 +4,7 @@
 <FILE>gstdmabuf</FILE>
 <TITLE>dmabuf</TITLE>
 <INCLUDE>gst/allocators/gstdmabuf.h</INCLUDE>
+gst_dmabuf_allocator_new
 gst_dmabuf_allocator_alloc
 gst_dmabuf_memory_get_fd
 gst_is_dmabuf_memory
@@ -12,6 +13,29 @@ GST_ALLOCATOR_DMABUF
 <SUBSECTION Private>
 </SECTION>
 
+<SECTION>
+<FILE>gstfdmemory</FILE>
+<TITLE>fdmemory</TITLE>
+<INCLUDE>gst/allocators/gstfdmemory.h</INCLUDE>
+GstFdMemoryFlags
+gst_fd_allocator_alloc
+gst_fd_allocator_get_type
+gst_fd_allocator_new
+gst_fd_memory_get_fd
+gst_is_fd_memory
+<SUBSECTION Standard>
+GstFdAllocator
+GstFdAllocatorClass
+GST_ALLOCATOR_FD
+GST_FD_ALLOCATOR
+GST_FD_ALLOCATOR_CAST
+GST_FD_ALLOCATOR_CLASS
+GST_FD_ALLOCATOR_GET_CLASS
+GST_IS_FD_ALLOCATOR
+GST_IS_FD_ALLOCATOR_CLASS
+<SUBSECTION Private>
+</SECTION>
+
 # app
 <SECTION>
 <FILE>gstappsrc</FILE>
index 95f544f..4f2348d 100644 (file)
  * Boston, MA 02111-1307, USA.
  */
 
+/**
+ * SECTION:gstfdmemory
+ * @short_description: Memory wrapper for fd backed memory
+ * @see_also: #GstMemory
+ *
+ * Since: 1.4
+ */
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
index 7062789..e2da2d7 100644 (file)
@@ -40,7 +40,6 @@ typedef struct _GstFdAllocatorClass GstFdAllocatorClass;
 
 /**
  * GstFdMemoryFlags:
- *
  * @GST_FD_MEMORY_FLAG_NONE: no flag
  * @GST_FD_MEMORY_FLAG_KEEP_MAPPED: once the memory is mapped,
  *        keep it mapped until the memory is destroyed.