From b06e86fb1822d5817ef79fab7be5d6bc7bbbbd9b Mon Sep 17 00:00:00 2001 From: Stefan Sauer Date: Fri, 31 Jan 2014 08:35:41 +0100 Subject: [PATCH] docs: unhide docs for allocator Unhinde the class docs. Tech gtk-doc about GST_EXPORTS. --- docs/gst/Makefile.am | 3 ++- docs/gst/gstreamer-sections.txt | 2 +- gst/gstallocator.h | 12 ++++++++++-- 3 files changed, 13 insertions(+), 4 deletions(-) diff --git a/docs/gst/Makefile.am b/docs/gst/Makefile.am index c0dedc60ce..640bf56970 100644 --- a/docs/gst/Makefile.am +++ b/docs/gst/Makefile.am @@ -24,7 +24,8 @@ DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml DOC_SOURCE_DIR = $(top_srcdir)/gst # Extra options to supply to gtkdoc-scan. -SCAN_OPTIONS=--deprecated-guards="GST_DISABLE_DEPRECATED" +SCAN_OPTIONS=--deprecated-guards="GST_DISABLE_DEPRECATED" \ + --ignore-decorators='GST_EXPORT' # Extra options to supply to gtkdoc-mkdb. MKDB_OPTIONS=--sgml-mode --output-format=xml --ignore-files=parse diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt index f20029db3d..b198b637ca 100644 --- a/docs/gst/gstreamer-sections.txt +++ b/docs/gst/gstreamer-sections.txt @@ -1375,6 +1375,7 @@ gst_iterator_result_get_type gst_memory_alignment GstAllocator +GstAllocatorClass GstAllocatorFlags GstAllocationParams @@ -1399,7 +1400,6 @@ GST_ALLOCATOR_CLASS GST_ALLOCATOR_GET_CLASS GST_IS_ALLOCATOR GST_IS_ALLOCATOR_CLASS -GstAllocatorClass GST_TYPE_ALLOCATOR_FLAGS GstAllocatorPrivate diff --git a/gst/gstallocator.h b/gst/gstallocator.h index 2337855064..99deee212a 100644 --- a/gst/gstallocator.h +++ b/gst/gstallocator.h @@ -92,8 +92,6 @@ typedef enum { /** * GstAllocator: - * @object: parent structure - * @mem_type: the memory type this allocator provides * @mem_map: the implementation of the GstMemoryMapFunction * @mem_unmap: the implementation of the GstMemoryUnmapFunction * @mem_copy: the implementation of the GstMemoryCopyFunction @@ -108,6 +106,7 @@ struct _GstAllocator const gchar *mem_type; + /*< public >*/ GstMemoryMapFunction mem_map; GstMemoryUnmapFunction mem_unmap; @@ -121,9 +120,18 @@ struct _GstAllocator GstAllocatorPrivate *priv; }; +/** + * GstAllocatorClass: + * @object_class: Object parent class + * @alloc: implementation that acquires memory + * @free: implementation that releases memory + * + * The #GstAllocator is used to create new memory. + */ struct _GstAllocatorClass { GstObjectClass object_class; + /*< public >*/ GstMemory * (*alloc) (GstAllocator *allocator, gsize size, GstAllocationParams *params); void (*free) (GstAllocator *allocator, GstMemory *memory);