From: Sebastian Dröge <sebastian.droege@collabora.co.uk>
Date: Tue, 19 Feb 2013 09:05:17 +0000 (+0100)
Subject: allocators: Integrate into the documentation
X-Git-Tag: 1.19.3~511^2~5596
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=26ff0ced15cbfd9b2c892b5f8b5a7792a2e9fb18;p=platform%2Fupstream%2Fgstreamer.git

allocators: Integrate into the documentation
---

diff --git a/docs/libs/Makefile.am b/docs/libs/Makefile.am
index 1285061..54126f8 100644
--- a/docs/libs/Makefile.am
+++ b/docs/libs/Makefile.am
@@ -57,6 +57,7 @@ extra_files =
 # contains GtkObjects/GObjects and you want to document signals and properties.
 GTKDOC_CFLAGS = $(GST_PLUGINS_BASE_CFLAGS) $(GST_BASE_CFLAGS)
 GTKDOC_LIBS = \
+	$(top_builddir)/gst-libs/gst/allocators/libgstallocators-@GST_API_VERSION@.la \
 	$(top_builddir)/gst-libs/gst/audio/libgstaudio-@GST_API_VERSION@.la \
 	$(top_builddir)/gst-libs/gst/fft/libgstfft-@GST_API_VERSION@.la \
 	$(top_builddir)/gst-libs/gst/rtp/libgstrtp-@GST_API_VERSION@.la \
diff --git a/docs/libs/gst-plugins-base-libs-docs.sgml b/docs/libs/gst-plugins-base-libs-docs.sgml
index 828deba..78cc3d5 100644
--- a/docs/libs/gst-plugins-base-libs-docs.sgml
+++ b/docs/libs/gst-plugins-base-libs-docs.sgml
@@ -21,6 +21,16 @@
     </para>
     <xi:include href="compiling.sgml" />
 
+    <chapter id="gstreamer-allocators">
+      <title>Allocators Library</title>
+      <para>
+        This library should be linked to by getting cflags and libs from
+        <filename>gstreamer-plugins-base-&GST_API_VERSION;.pc</filename> and adding
+        <filename>-lgstallocators-&GST_API_VERSION;</filename> to the library flags.
+      </para>
+      <xi:include href="xml/gstdmabuf.xml" />
+    </chapter>
+
     <chapter id="gstreamer-app">
       <title>App Library</title>
       <para>
diff --git a/docs/libs/gst-plugins-base-libs-sections.txt b/docs/libs/gst-plugins-base-libs-sections.txt
index ecc787c..d5d196a 100644
--- a/docs/libs/gst-plugins-base-libs-sections.txt
+++ b/docs/libs/gst-plugins-base-libs-sections.txt
@@ -1,3 +1,17 @@
+# allocators
+
+<SECTION>
+<FILE>gstdmabuf</FILE>
+<TITLE>dmabuf</TITLE>
+<INCLUDE>gst/allocators/gstdmabuf.h</INCLUDE>
+gst_dmabuf_allocator_alloc
+gst_dmabuf_allocator_obtain
+gst_dmabuf_memory_get_fd
+gst_is_dmabuf_memory
+<SUBSECTION Standard>
+<SUBSECTION Private>
+</SECTION>
+
 # app
 <SECTION>
 <FILE>gstappsrc</FILE>
diff --git a/gst-libs/gst/allocators/gstdmabuf.c b/gst-libs/gst/allocators/gstdmabuf.c
index d6194d5..a822acf 100644
--- a/gst-libs/gst/allocators/gstdmabuf.c
+++ b/gst-libs/gst/allocators/gstdmabuf.c
@@ -22,6 +22,13 @@
 
 #include "gstdmabuf.h"
 
+/**
+ * SECTION:gstdmabuf
+ * @short_description: Memory wrapper for Linux dmabuf memory
+ * @see_also: #GstMemory
+ *
+ */
+
 #ifdef HAVE_MMAP
 #include <sys/mman.h>
 #include <unistd.h>