From: Tim-Philipp Müller <tim@centricular.com>
Date: Thu, 8 Mar 2018 01:01:53 +0000 (+0000)
Subject: docs: add GstPhysMemoryAllocator to docs
X-Git-Tag: 1.19.3~511^2~1814
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=98fc23062f211ac1ffe96802bfe891869615660d;p=platform%2Fupstream%2Fgstreamer.git

docs: add GstPhysMemoryAllocator to docs
---

diff --git a/docs/libs/gst-plugins-base-libs-docs.sgml b/docs/libs/gst-plugins-base-libs-docs.sgml
index 1e950c0..23767ac 100644
--- a/docs/libs/gst-plugins-base-libs-docs.sgml
+++ b/docs/libs/gst-plugins-base-libs-docs.sgml
@@ -30,6 +30,7 @@
       </para>
       <xi:include href="xml/gstdmabuf.xml" />
       <xi:include href="xml/gstfdmemory.xml" />
+      <xi:include href="xml/gstphysmemoryallocator.xml" />
     </chapter>
 
     <chapter id="gstreamer-app">
diff --git a/docs/libs/gst-plugins-base-libs-sections.txt b/docs/libs/gst-plugins-base-libs-sections.txt
index 53d0b00..c2d289c 100644
--- a/docs/libs/gst-plugins-base-libs-sections.txt
+++ b/docs/libs/gst-plugins-base-libs-sections.txt
@@ -48,6 +48,26 @@ GST_TYPE_FD_ALLOCATOR
 <SUBSECTION Private>
 </SECTION>
 
+<SECTION>
+<FILE>gstphysmemoryallocator</FILE>
+<TITLE>GstPhysMemoryAllocator</TITLE>
+<INCLUDE>gst/allocators/allocators.h</INCLUDE>
+GstPhysMemoryAllocator
+GstPhysMemoryAllocatorInterface
+gst_is_phys_memory
+gst_phys_memory_get_phys_addr
+<SUBSECTION Standard>
+GST_TYPE_PHYS_MEMORY_ALLOCATOR
+GST_IS_PHYS_MEMORY_ALLOCATOR
+GST_IS_PHYS_MEMORY_ALLOCATOR_INTERFACE
+GST_PHYS_MEMORY_ALLOCATOR_GET_INTERFACE
+GST_PHYS_MEMORY_ALLOCATOR
+GST_PHYS_MEMORY_ALLOCATOR_INTERFACE
+GST_PHYS_MEMORY_ALLOCATOR_CAST
+gst_phys_memory_allocator_get_type
+<SUBSECTION Private>
+</SECTION>
+
 # app
 <SECTION>
 <FILE>gstappsrc</FILE>
diff --git a/gst-libs/gst/allocators/gstphysmemory.c b/gst-libs/gst/allocators/gstphysmemory.c
index 4e1a898..db74391 100644
--- a/gst-libs/gst/allocators/gstphysmemory.c
+++ b/gst-libs/gst/allocators/gstphysmemory.c
@@ -17,6 +17,14 @@
  * Boston, MA 02111-1307, USA.
  */
 
+/**
+ * SECTION:gstphysmemoryallocator
+ * @title: GstPhysMemoryAllocator
+ * @short_description: Interface for allocators that pass around physical memory addresses
+ * @see_also: #GstMemory
+ *
+ * Since: 1.14
+ */
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif