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

gst: Fix various Since markers

Browse source
This commit is contained in:
Sebastian Dröge 2019-04-23 15:08:18 +03:00 committed by Tim-Philipp Müller
parent 41e3ecb080
commit 2fa00da84e
20 changed files with 48 additions and 48 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
gst/gstallocator.h
View file

@ -102,9 +102,9 @@ typedef enum {
* @mem_share: the implementation of the GstMemoryShareFunction
* @mem_is_span: the implementation of the GstMemoryIsSpanFunction
* @mem_map_full: the implementation of the GstMemoryMapFullFunction.
* Will be used instead of @mem_map if present. (Since 1.6)
* Will be used instead of @mem_map if present. (Since: 1.6)
* @mem_unmap_full: the implementation of the GstMemoryUnmapFullFunction.
* Will be used instead of @mem_unmap if present. (Since 1.6)
* Will be used instead of @mem_unmap if present. (Since: 1.6)
*
* The #GstAllocator is used to create new memory.
*/

4
gst/gstbin.h
View file

@ -41,10 +41,10 @@ G_BEGIN_DECLS
/**
* GstBinFlags:
* @GST_BIN_FLAG_NO_RESYNC: don't resync a state change when elements are
* added or linked in the bin (Since 1.0.5)
* added or linked in the bin (Since: 1.0.5)
* @GST_BIN_FLAG_STREAMS_AWARE: Indicates whether the bin can handle elements
* that add/remove source pads at any point in time without
* first posting a no-more-pads signal (Since 1.10)
* first posting a no-more-pads signal (Since: 1.10)
* @GST_BIN_FLAG_LAST: the last enum in the series of flags for bins.
* Derived classes can use this as first value in a list of flags.
*

2
gst/gstbuffer.c
View file

@ -113,7 +113,7 @@
* Typically, #GstParentBufferMeta is used when the child buffer is directly
* using the #GstMemory of the parent buffer, and wants to prevent the parent
* buffer from being returned to a buffer pool until the #GstMemory is available
* for re-use. (Since 1.6)
* for re-use. (Since: 1.6)
*
*/
#include "gst_private.h"

6
gst/gstbuffer.h
View file

@ -209,12 +209,12 @@ typedef struct _GstBufferPool GstBufferPool;
* is added/removed
* @GST_BUFFER_FLAG_SYNC_AFTER: Elements which write to disk or permanent
* storage should ensure the data is synced after
* writing the contents of this buffer. (Since 1.6)
* writing the contents of this buffer. (Since: 1.6)
* @GST_BUFFER_FLAG_NON_DROPPABLE: This buffer is important and should not be dropped.
* This can be used to mark important buffers, e.g. to flag
* RTP packets carrying keyframes or codec setup data for RTP
* Forward Error Correction purposes, or to prevent still video
* frames from being dropped by elements due to QoS. (Since 1.14)
* frames from being dropped by elements due to QoS. (Since: 1.14)
* @GST_BUFFER_FLAG_LAST: additional media specific flags can be added starting from
* this flag.
*
@ -500,7 +500,7 @@ GstBuffer * gst_buffer_copy_deep (const GstBuffer * buf);
* @GST_BUFFER_COPY_META: flag indicating that buffer meta should be
* copied
* @GST_BUFFER_COPY_DEEP: flag indicating that memory should always be
* copied instead of reffed (Since 1.2)
* copied instead of reffed (Since: 1.2)
*
* A set of flags that can be provided to the gst_buffer_copy_into()
* function to specify which items should be copied.

4
gst/gstbufferpool.h
View file

@ -146,8 +146,8 @@ struct _GstBufferPool {
* is not set on the buffer. If #GST_BUFFER_FLAG_TAG_MEMORY is set, the
* buffer will be freed with @free_buffer.
* @free_buffer: free a buffer. The default implementation unrefs the buffer.
* @flush_start: enter the flushing state. (Since 1.4)
* @flush_stop: leave the flushign state. (Since 1.4)
* @flush_start: enter the flushing state. (Since: 1.4)
* @flush_stop: leave the flushign state. (Since: 1.4)
*
* The GstBufferPool class.
*/

2
gst/gstclock.h
View file

@ -424,7 +424,7 @@ struct _GstClockEntry {
* @GST_CLOCK_FLAG_CAN_SET_RESOLUTION: clock's resolution can be changed
* @GST_CLOCK_FLAG_CAN_SET_MASTER: clock can be slaved to a master clock
* @GST_CLOCK_FLAG_NEEDS_STARTUP_SYNC: clock needs to be synced before it can be used
* (Since 1.6)
* (Since: 1.6)
* @GST_CLOCK_FLAG_LAST: subclasses can add additional flags starting from this flag
*
* The capabilities of this clock

8
gst/gstelement.h
View file

@ -230,14 +230,14 @@ typedef enum {
* @GST_STATE_CHANGE_READY_TO_NULL : state change from READY to NULL.
* * Elements close devices
* * Elements reset any internal state.
* @GST_STATE_CHANGE_NULL_TO_NULL : state change from NULL to NULL. (Since 1.14)
* @GST_STATE_CHANGE_NULL_TO_NULL : state change from NULL to NULL. (Since: 1.14)
* @GST_STATE_CHANGE_READY_TO_READY : state change from READY to READY,
* This might happen when going to PAUSED asynchronously failed, in that case
* elements should make sure they are in a proper, coherent READY state. (Since 1.14)
* elements should make sure they are in a proper, coherent READY state. (Since: 1.14)
* @GST_STATE_CHANGE_PAUSED_TO_PAUSED : state change from PAUSED to PAUSED.
* This might happen when elements were in PLAYING state and 'lost state',
* they should make sure to go back to real 'PAUSED' state (prerolling for example). (Since 1.14)
* @GST_STATE_CHANGE_PLAYING_TO_PLAYING : state change from PLAYING to PLAYING. (Since 1.14)
* they should make sure to go back to real 'PAUSED' state (prerolling for example). (Since: 1.14)
* @GST_STATE_CHANGE_PLAYING_TO_PLAYING : state change from PLAYING to PLAYING. (Since: 1.14)
*
* These are the different state changes an element goes through.
* %GST_STATE_NULL ⇒ %GST_STATE_PLAYING is called an upwards state change

4
gst/gstelementfactory.h
View file

@ -103,8 +103,8 @@ gboolean gst_element_register (GstPlugin *plug
* @GST_ELEMENT_FACTORY_TYPE_PARSER: Parser elements
* @GST_ELEMENT_FACTORY_TYPE_PAYLOADER: Payloader elements
* @GST_ELEMENT_FACTORY_TYPE_DEPAYLOADER: Depayloader elements
* @GST_ELEMENT_FACTORY_TYPE_DECRYPTOR: Elements handling decryption (Since 1.6)
* @GST_ELEMENT_FACTORY_TYPE_ENCRYPTOR: Elements handling encryption (Since 1.6)
* @GST_ELEMENT_FACTORY_TYPE_DECRYPTOR: Elements handling decryption (Since: 1.6)
* @GST_ELEMENT_FACTORY_TYPE_ENCRYPTOR: Elements handling encryption (Since: 1.6)
* @GST_ELEMENT_FACTORY_TYPE_MAX_ELEMENTS: Private, do not use
* @GST_ELEMENT_FACTORY_TYPE_MEDIA_VIDEO: Elements handling video media types
* @GST_ELEMENT_FACTORY_TYPE_MEDIA_AUDIO: Elements handling audio media types

2
gst/gsterror.h
View file

@ -126,7 +126,7 @@ typedef enum
* @GST_RESOURCE_ERROR_NO_SPACE_LEFT: used when the resource has no space left.
* @GST_RESOURCE_ERROR_NOT_AUTHORIZED: used when the resource can't be opened
* due to missing authorization.
* (Since 1.2.4)
* (Since: 1.2.4)
* @GST_RESOURCE_ERROR_NUM_ERRORS: the number of resource error types.
*
* Resource errors are for any resource used by an element:

6
gst/gstevent.h
View file

@ -79,7 +79,7 @@ typedef enum {
* from the pipeline and unblock all streaming threads.
* @GST_EVENT_FLUSH_STOP: Stop a flush operation. This event resets the
* running-time of the pipeline.
* @GST_EVENT_SELECT_STREAMS: A request to select one or more streams (Since 1.10)
* @GST_EVENT_SELECT_STREAMS: A request to select one or more streams (Since: 1.10)
* @GST_EVENT_STREAM_START: Event to mark the start of a new stream. Sent before any
* other serialized event and only sent at the start of a new stream,
* not after flushing seeks.
@ -88,7 +88,7 @@ typedef enum {
* segment events contains information for clipping buffers and
* converting buffer timestamps to running-time and
* stream-time.
* @GST_EVENT_STREAM_COLLECTION: A new #GstStreamCollection is available (Since 1.10)
* @GST_EVENT_STREAM_COLLECTION: A new #GstStreamCollection is available (Since: 1.10)
* @GST_EVENT_TAG: A new set of metadata tags has been found in the stream.
* @GST_EVENT_BUFFERSIZE: Notification of buffering requirements. Currently not
* used yet.
@ -97,7 +97,7 @@ typedef enum {
* rendering.
* @GST_EVENT_STREAM_GROUP_DONE: Indicates that there is no more data for
* the stream group ID in the message. Sent before EOS
* in some instances and should be handled mostly the same. (Since 1.10)
* in some instances and should be handled mostly the same. (Since: 1.10)
* @GST_EVENT_EOS: End-Of-Stream. No more data is to be expected to follow
* without either a STREAM_START event, or a FLUSH_STOP and a SEGMENT
* event.

4
gst/gstmemory.h
View file

@ -50,8 +50,8 @@ typedef struct _GstAllocator GstAllocator;
* made when this memory needs to be shared between buffers.
* @GST_MEMORY_FLAG_ZERO_PREFIXED: the memory prefix is filled with 0 bytes
* @GST_MEMORY_FLAG_ZERO_PADDED: the memory padding is filled with 0 bytes
* @GST_MEMORY_FLAG_PHYSICALLY_CONTIGUOUS: the memory is physically contiguous. (Since 1.2)
* @GST_MEMORY_FLAG_NOT_MAPPABLE: the memory can't be mapped via gst_memory_map() without any preconditions. (Since 1.2)
* @GST_MEMORY_FLAG_PHYSICALLY_CONTIGUOUS: the memory is physically contiguous. (Since: 1.2)
* @GST_MEMORY_FLAG_NOT_MAPPABLE: the memory can't be mapped via gst_memory_map() without any preconditions. (Since: 1.2)
* @GST_MEMORY_FLAG_LAST: first flag that can be used for custom purposes
*
* Flags for wrapped memory.

20
gst/gstmessage.h
View file

@ -99,28 +99,28 @@ typedef struct _GstMessage GstMessage;
* e.g. when using playbin in gapless playback mode, to get notified when
* the next title actually starts playing (which will be some time after
* the URI for the next title has been set).
* @GST_MESSAGE_NEED_CONTEXT: Message indicating that an element wants a specific context (Since 1.2)
* @GST_MESSAGE_HAVE_CONTEXT: Message indicating that an element created a context (Since 1.2)
* @GST_MESSAGE_NEED_CONTEXT: Message indicating that an element wants a specific context (Since: 1.2)
* @GST_MESSAGE_HAVE_CONTEXT: Message indicating that an element created a context (Since: 1.2)
* @GST_MESSAGE_EXTENDED: Message is an extended message type (see below).
* These extended message IDs can't be used directly with mask-based API
* like gst_bus_poll() or gst_bus_timed_pop_filtered(), but you can still
* filter for GST_MESSAGE_EXTENDED and then check the result for the
* specific type. (Since 1.4)
* specific type. (Since: 1.4)
* @GST_MESSAGE_DEVICE_ADDED: Message indicating a #GstDevice was added to
* a #GstDeviceProvider (Since 1.4)
* a #GstDeviceProvider (Since: 1.4)
* @GST_MESSAGE_DEVICE_REMOVED: Message indicating a #GstDevice was removed
* from a #GstDeviceProvider (Since 1.4)
* from a #GstDeviceProvider (Since: 1.4)
* @GST_MESSAGE_PROPERTY_NOTIFY: Message indicating a #GObject property has
* changed (Since 1.10)
* changed (Since: 1.10)
* @GST_MESSAGE_STREAM_COLLECTION: Message indicating a new #GstStreamCollection
* is available (Since 1.10)
* is available (Since: 1.10)
* @GST_MESSAGE_STREAMS_SELECTED: Message indicating the active selection of
* #GstStreams has changed (Since 1.10)
* #GstStreams has changed (Since: 1.10)
* @GST_MESSAGE_REDIRECT: Message indicating to request the application to
* try to play the given URL(s). Useful if for example a HTTP 302/303
* response is received with a non-HTTP URL inside. (Since 1.10)
* response is received with a non-HTTP URL inside. (Since: 1.10)
* @GST_MESSAGE_DEVICE_CHANGED: Message indicating a #GstDevice was changed
* a #GstDeviceProvider (Since 1.16)
* a #GstDeviceProvider (Since: 1.16)
* @GST_MESSAGE_ANY: mask for all of the above messages.
*
* The different message types that are available.

2
gst/gstminiobject.h
View file

@ -126,7 +126,7 @@ typedef void (*GstMiniObjectNotify) (gpointer user_data, GstMiniObject * obj);
* READONLY mode. Only read locks can be performed on the object.
* @GST_MINI_OBJECT_FLAG_MAY_BE_LEAKED: the object is expected to stay alive
* even after gst_deinit() has been called and so should be ignored by leak
* detection tools. (Since 1.10)
* detection tools. (Since: 1.10)
* @GST_MINI_OBJECT_FLAG_LAST: first flag that can be used by subclasses.
*
* Flags for the mini object

2
gst/gstobject.h
View file

@ -43,7 +43,7 @@ G_BEGIN_DECLS
* GstObjectFlags:
* @GST_OBJECT_FLAG_MAY_BE_LEAKED: the object is expected to stay alive even
* after gst_deinit() has been called and so should be ignored by leak
* detection tools. (Since 1.10)
* detection tools. (Since: 1.10)
* @GST_OBJECT_FLAG_LAST: subclasses can add additional flags starting from this flag
*
* The standard flags that an gstobject may have.

2
gst/gstpad.h
View file

@ -695,7 +695,7 @@ typedef gboolean (*GstPadStickyEventsForeachFunction) (GstPad *pad, GstEvent **
* @GST_PAD_FLAG_ACCEPT_TEMPLATE: the default accept-caps handler will use
* the template pad caps instead of query caps to
* compare with the accept caps. Use this in combination
* with %GST_PAD_FLAG_ACCEPT_INTERSECT. (Since 1.6)
* with %GST_PAD_FLAG_ACCEPT_INTERSECT. (Since: 1.6)
* @GST_PAD_FLAG_LAST: offset to define more flags
*
* Pad state flags

2
gst/gstparse.h
View file

@ -73,7 +73,7 @@ typedef enum
* just return the element.
* @GST_PARSE_FLAG_PLACE_IN_BIN: If more than one toplevel element is described
* by the pipeline description string, put them in a #GstBin instead of a
* #GstPipeline. (Since 1.10)
* #GstPipeline. (Since: 1.10)
*
* Parsing options.
*/

2
gst/gstplugin.h
View file

@ -97,7 +97,7 @@ typedef enum
* the directory
* @GST_PLUGIN_DEPENDENCY_FLAG_FILE_NAME_IS_PREFIX : interpret
* filename argument as filter prefix and check all matching files in
* the directory. Since 1.8.
* the directory. Since: 1.8.
* @GST_PLUGIN_DEPENDENCY_FLAG_PATHS_ARE_RELATIVE_TO_EXE : interpret
* non-absolute paths as relative to the main executable directory. Since
* 1.14.

12
gst/gstsegment.h
View file

@ -58,7 +58,7 @@ typedef enum {
* @GST_SEEK_FLAG_SEGMENT: perform a segment seek.
* @GST_SEEK_FLAG_TRICKMODE: when doing fast forward or fast reverse playback, allow
* elements to skip frames instead of generating all
* frames. (Since 1.6)
* frames. (Since: 1.6)
* @GST_SEEK_FLAG_SNAP_BEFORE: go to a location before the requested position,
* if %GST_SEEK_FLAG_KEY_UNIT this means the keyframe at or before
* the requested position the one at or before the seek target.
@ -72,10 +72,10 @@ typedef enum {
* @GST_SEEK_FLAG_TRICKMODE_KEY_UNITS: when doing fast forward or fast reverse
* playback, request that elements only decode keyframes
* and skip all other content, for formats that have
* keyframes. (Since 1.6)
* keyframes. (Since: 1.6)
* @GST_SEEK_FLAG_TRICKMODE_NO_AUDIO: when doing fast forward or fast reverse
* playback, request that audio decoder elements skip
* decoding and output only gap events or silence. (Since 1.6)
* decoding and output only gap events or silence. (Since: 1.6)
* @GST_SEEK_FLAG_SKIP: Deprecated backward compatibility flag, replaced
* by %GST_SEEK_FLAG_TRICKMODE
*
@ -144,12 +144,12 @@ typedef enum {
* @GST_SEGMENT_FLAG_NONE: no flags
* @GST_SEGMENT_FLAG_RESET: reset the pipeline running_time to the segment
* running_time
* @GST_SEGMENT_FLAG_TRICKMODE: perform skip playback (Since 1.6)
* @GST_SEGMENT_FLAG_TRICKMODE: perform skip playback (Since: 1.6)
* @GST_SEGMENT_FLAG_SEGMENT: send SEGMENT_DONE instead of EOS
* @GST_SEGMENT_FLAG_TRICKMODE_KEY_UNITS: Decode only keyframes, where
* possible (Since 1.6)
* possible (Since: 1.6)
* @GST_SEGMENT_FLAG_TRICKMODE_NO_AUDIO: Do not decode any audio, where
* possible (Since 1.6)
* possible (Since: 1.6)
* @GST_SEGMENT_FLAG_SKIP: Deprecated backward compatibility flag, replaced
* by @GST_SEGMENT_FLAG_TRICKMODE
*

6
gst/gststructure.c
View file

@ -3101,7 +3101,7 @@ gst_structure_get_array (GstStructure * structure, const gchar * fieldname,
* with @fieldname or the existing field did not contain a %GST_TYPE_LIST, this
* function returns %FALSE.
*
* Since 1.12
* Since: 1.12
*/
gboolean
gst_structure_get_list (GstStructure * structure, const gchar * fieldname,
@ -3149,7 +3149,7 @@ _gst_structure_set_any_list (GstStructure * structure, GType type,
* the field specified by @fieldname. Be aware that this is slower then using
* %GST_TYPE_ARRAY in a #GValue directly.
*
* Since 1.12
* Since: 1.12
*/
void
gst_structure_set_array (GstStructure * structure, const gchar * fieldname,
@ -3169,7 +3169,7 @@ gst_structure_set_array (GstStructure * structure, const gchar * fieldname,
* the field specified by @fieldname. Be aware that this is slower then using
* %GST_TYPE_LIST in a #GValue directly.
*
* Since 1.12
* Since: 1.12
*/
void
gst_structure_set_list (GstStructure * structure, const gchar * fieldname,

2
gst/gstsystemclock.h
View file

@ -47,7 +47,7 @@ typedef struct _GstSystemClockPrivate GstSystemClockPrivate;
* @GST_CLOCK_TYPE_REALTIME: time since Epoch
* @GST_CLOCK_TYPE_MONOTONIC: monotonic time since some unspecified starting
* point
* @GST_CLOCK_TYPE_OTHER: some other time source is used (Since 1.0.5)
* @GST_CLOCK_TYPE_OTHER: some other time source is used (Since: 1.0.5)
*
* The different kind of clocks.
*/