mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-11-26 19:51:11 +00:00
Code Issues 1 Projects Releases Wiki Activity

docs: unhide docs for allocator

Browse source 
Unhinde the class docs. Tech gtk-doc about GST_EXPORTS.
This commit is contained in:
Stefan Sauer 2014-01-31 08:35:41 +01:00
parent c42780db66
commit b06e86fb18
3 changed files with 13 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
docs/gst/Makefile.am
View file

@ -24,7 +24,8 @@ DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
DOC_SOURCE_DIR = $(top_srcdir)/gst DOC_SOURCE_DIR = $(top_srcdir)/gst
# Extra options to supply to gtkdoc-scan. # 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. # Extra options to supply to gtkdoc-mkdb.
MKDB_OPTIONS=--sgml-mode --output-format=xml --ignore-files=parse MKDB_OPTIONS=--sgml-mode --output-format=xml --ignore-files=parse

2
docs/gst/gstreamer-sections.txt
View file

@ -1375,6 +1375,7 @@ gst_iterator_result_get_type
gst_memory_alignment gst_memory_alignment
GstAllocator GstAllocator
GstAllocatorClass
GstAllocatorFlags GstAllocatorFlags
GstAllocationParams GstAllocationParams
@ -1399,7 +1400,6 @@ GST_ALLOCATOR_CLASS
GST_ALLOCATOR_GET_CLASS GST_ALLOCATOR_GET_CLASS
GST_IS_ALLOCATOR GST_IS_ALLOCATOR
GST_IS_ALLOCATOR_CLASS GST_IS_ALLOCATOR_CLASS
GstAllocatorClass
<SUBSECTION Private> <SUBSECTION Private>
GST_TYPE_ALLOCATOR_FLAGS GST_TYPE_ALLOCATOR_FLAGS
GstAllocatorPrivate GstAllocatorPrivate

12
gst/gstallocator.h
View file

@ -92,8 +92,6 @@ typedef enum {
/** /**
* GstAllocator: * GstAllocator:
* @object: parent structure
* @mem_type: the memory type this allocator provides
* @mem_map: the implementation of the GstMemoryMapFunction * @mem_map: the implementation of the GstMemoryMapFunction
* @mem_unmap: the implementation of the GstMemoryUnmapFunction * @mem_unmap: the implementation of the GstMemoryUnmapFunction
* @mem_copy: the implementation of the GstMemoryCopyFunction * @mem_copy: the implementation of the GstMemoryCopyFunction
@ -108,6 +106,7 @@ struct _GstAllocator
const gchar *mem_type; const gchar *mem_type;
/*< public >*/
GstMemoryMapFunction mem_map; GstMemoryMapFunction mem_map;
GstMemoryUnmapFunction mem_unmap; GstMemoryUnmapFunction mem_unmap;
@ -121,9 +120,18 @@ struct _GstAllocator
GstAllocatorPrivate *priv; 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 { struct _GstAllocatorClass {
GstObjectClass object_class; GstObjectClass object_class;
/*< public >*/
GstMemory * (*alloc) (GstAllocator *allocator, gsize size, GstMemory * (*alloc) (GstAllocator *allocator, gsize size,
GstAllocationParams *params); GstAllocationParams *params);
void (*free) (GstAllocator *allocator, GstMemory *memory); void (*free) (GstAllocator *allocator, GstMemory *memory);