summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorSebastian Dröge <sebastian.droege@collabora.co.uk>2013-02-19 10:05:17 +0100
committerSebastian Dröge <sebastian.droege@collabora.co.uk>2013-02-19 10:05:38 +0100
commit26ff0ced15cbfd9b2c892b5f8b5a7792a2e9fb18 (patch)
treee0096943b339430843a94c5dde2213d72970ab74 /docs
parentd405dddd507f0503e5b10344703406749b1d0762 (diff)
allocators: Integrate into the documentation
Diffstat (limited to 'docs')
-rw-r--r--docs/libs/Makefile.am1
-rw-r--r--docs/libs/gst-plugins-base-libs-docs.sgml10
-rw-r--r--docs/libs/gst-plugins-base-libs-sections.txt14
3 files changed, 25 insertions, 0 deletions
diff --git a/docs/libs/Makefile.am b/docs/libs/Makefile.am
index 12850611d..54126f82a 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 828debad2..78cc3d5de 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 ecc787c0c..d5d196af1 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>