mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-11-23 02:01:12 +00:00
docs: unhide docs for allocator
Unhinde the class docs. Tech gtk-doc about GST_EXPORTS.
This commit is contained in:
parent
c42780db66
commit
b06e86fb18
3 changed files with 13 additions and 4 deletions
|
@ -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
|
||||
|
|
|
@ -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
|
||||
<SUBSECTION Private>
|
||||
GST_TYPE_ALLOCATOR_FLAGS
|
||||
GstAllocatorPrivate
|
||||
|
|
|
@ -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);
|
||||
|
|
Loading…
Reference in a new issue