mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-02-17 03:35:21 +00:00
Code Issues 1 Projects Releases Wiki Activity

docs: cosmetic since marker fixes

Browse source
This commit is contained in:
Tim-Philipp Müller 2013-11-16 12:24:56 +00:00
parent e24722c52c
commit 9f669e5ea5
8 changed files with 31 additions and 31 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
gst/gstbin.h
View file

@ -41,7 +41,7 @@ G_BEGIN_DECLS
/**
* GstBinFlags:
* @GST_BIN_FLAG_NO_RESYNC: don't resync a state change when elements are
* added or linked in the bin.
* added or linked in the bin (Since 1.0.5)
* @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.
*
@ -62,7 +62,7 @@ typedef enum {
* Check if @bin will resync its state change when elements are added and
* removed.
*
* Since: 1.1.1
* Since: 1.0.5
*/
#define GST_BIN_IS_NO_RESYNC(bin) (GST_OBJECT_FLAG_IS_SET(bin,GST_BIN_FLAG_NO_RESYNC))

2
gst/gstbuffer.c
View file

@ -341,7 +341,7 @@ _priv_gst_buffer_initialize (void)
*
* Returns: the maximum amount of memory blocks that a buffer can hold.
*
* Since: 1.2.0
* Since: 1.2
*/
guint
gst_buffer_get_max_memory (void)

2
gst/gstinfo.c
View file

@ -1759,7 +1759,7 @@ parse_debug_level (gchar * str, GstDebugLevel * level)
* the order matters when you use wild cards, e.g. "foosrc:6,*src:3,*:2" sets
* everything to log level 2.
*
* Since: 1.2.0
* Since: 1.2
*/
void
gst_debug_set_threshold_from_string (const gchar * list, gboolean reset)

4
gst/gstplugin.h
View file

@ -198,7 +198,7 @@ struct _GstPluginDesc {
* and must be placed outside any block to declare the plugin initialization
* function.
*
* Since: 1.2.0
* Since: 1.2
*/
#define GST_PLUGIN_STATIC_DECLARE(name) \
extern void G_PASTE(gst_plugin_, G_PASTE(name, _register)) (void)
@ -212,7 +212,7 @@ struct _GstPluginDesc {
* It has to be used in combination with GST_PLUGIN_STATIC_DECLARE and
* calls the plugin initialization function.
*
* Since: 1.2.0
* Since: 1.2
*/
#define GST_PLUGIN_STATIC_REGISTER(name) G_PASTE(gst_plugin_, G_PASTE(name, _register)) ()

2
gst/gstpluginfeature.c
View file

@ -208,7 +208,7 @@ gst_plugin_feature_get_plugin (GstPluginFeature * feature)
* Returns: the name of the plugin that provides this feature, or %NULL if
* the feature is not associated with a plugin.
*
* Since: 1.2.0
* Since: 1.2
*/
const gchar *
gst_plugin_feature_get_plugin_name (GstPluginFeature * feature)

6
libs/gst/base/gstbasesink.c
View file

@ -529,7 +529,7 @@ gst_base_sink_class_init (GstBaseSinkClass * klass)
* Setting this property to a value bigger than 0 will make the sink delay
* rendering of the buffers when it would exceed to max-bitrate.
*
* Since: 1.1.1
* Since: 1.2
*/
g_object_class_install_property (gobject_class, PROP_MAX_BITRATE,
g_param_spec_uint64 ("max-bitrate", "Max Bitrate",
@ -1280,7 +1280,7 @@ gst_base_sink_get_throttle_time (GstBaseSink * sink)
*
* Set the maximum amount of bits per second that the sink will render.
*
* Since: 1.1.1
* Since: 1.2
*/
void
gst_base_sink_set_max_bitrate (GstBaseSink * sink, guint64 max_bitrate)
@ -1301,7 +1301,7 @@ gst_base_sink_set_max_bitrate (GstBaseSink * sink, guint64 max_bitrate)
*
* Returns: the maximum number of bits per second @sink will render.
*
* Since: 1.1.1
* Since: 1.2
*/
guint64
gst_base_sink_get_max_bitrate (GstBaseSink * sink)

24
libs/gst/base/gstdataqueue.c
View file

@ -222,7 +222,7 @@ gst_data_queue_init (GstDataQueue * queue)
*
* Returns: a new #GstDataQueue.
*
* Since: 1.2.0
* Since: 1.2
*/
GstDataQueue *
gst_data_queue_new (GstDataQueueCheckFullFunction checkfull,
@ -318,7 +318,7 @@ gst_data_queue_locked_is_full (GstDataQueue * queue)
* #gst_data_queue_pop will be released.
* MT safe.
*
* Since: 1.2.0
* Since: 1.2
*/
void
gst_data_queue_flush (GstDataQueue * queue)
@ -338,7 +338,7 @@ gst_data_queue_flush (GstDataQueue * queue)
*
* Returns: #TRUE if @queue is empty.
*
* Since: 1.2.0
* Since: 1.2
*/
gboolean
gst_data_queue_is_empty (GstDataQueue * queue)
@ -362,7 +362,7 @@ gst_data_queue_is_empty (GstDataQueue * queue)
*
* Returns: #TRUE if @queue is full.
*
* Since: 1.2.0
* Since: 1.2
*/
gboolean
gst_data_queue_is_full (GstDataQueue * queue)
@ -389,7 +389,7 @@ gst_data_queue_is_full (GstDataQueue * queue)
*
* MT Safe.
*
* Since: 1.2.0
* Since: 1.2
*/
void
gst_data_queue_set_flushing (GstDataQueue * queue, gboolean flushing)
@ -441,7 +441,7 @@ gst_data_queue_push_force_unlocked (GstDataQueue * queue,
*
* Returns: #TRUE if the @item was successfully pushed on the @queue.
*
* Since: 1.2.0
* Since: 1.2
*/
gboolean
gst_data_queue_push_force (GstDataQueue * queue, GstDataQueueItem * item)
@ -489,7 +489,7 @@ flushing:
*
* Returns: #TRUE if the @item was successfully pushed on the @queue.
*
* Since: 1.2.0
* Since: 1.2
*/
gboolean
gst_data_queue_push (GstDataQueue * queue, GstDataQueueItem * item)
@ -568,7 +568,7 @@ _gst_data_queue_wait_non_empty (GstDataQueue * queue)
*
* Returns: #TRUE if an @item was successfully retrieved from the @queue.
*
* Since: 1.2.0
* Since: 1.2
*/
gboolean
gst_data_queue_pop (GstDataQueue * queue, GstDataQueueItem ** item)
@ -638,7 +638,7 @@ is_of_type (gconstpointer a, gconstpointer b)
*
* Returns: #TRUE if an @item was successfully retrieved from the @queue.
*
* Since: 1.2.0
* Since: 1.2
*/
gboolean
gst_data_queue_peek (GstDataQueue * queue, GstDataQueueItem ** item)
@ -690,7 +690,7 @@ flushing:
*
* Returns: TRUE if an element was removed.
*
* Since: 1.2.0
* Since: 1.2
*/
gboolean
gst_data_queue_drop_head (GstDataQueue * queue, GType type)
@ -736,7 +736,7 @@ done:
* Inform the queue that the limits for the fullness check have changed and that
* any blocking gst_data_queue_push() should be unblocked to recheck the limts.
*
* Since: 1.2.0
* Since: 1.2
*/
void
gst_data_queue_limits_changed (GstDataQueue * queue)
@ -760,7 +760,7 @@ gst_data_queue_limits_changed (GstDataQueue * queue)
*
* Get the current level of the queue.
*
* Since: 1.2.0
* Since: 1.2
*/
void
gst_data_queue_get_level (GstDataQueue * queue, GstDataQueueSize * level)

18
libs/gst/base/gstqueuearray.c
View file

@ -52,7 +52,7 @@ struct _GstQueueArray
*
* Returns: a new #GstQueueArray object
*
* Since: 1.2.0
* Since: 1.2
*/
GstQueueArray *
gst_queue_array_new (guint initial_size)
@ -75,7 +75,7 @@ gst_queue_array_new (guint initial_size)
*
* Frees queue @array and all memory associated to it.
*
* Since: 1.2.0
* Since: 1.2
*/
void
gst_queue_array_free (GstQueueArray * array)
@ -93,7 +93,7 @@ gst_queue_array_free (GstQueueArray * array)
*
* Returns: The head of the queue
*
* Since: 1.2.0
* Since: 1.2
*/
gpointer
gst_queue_array_pop_head (GstQueueArray * array)
@ -119,7 +119,7 @@ gst_queue_array_pop_head (GstQueueArray * array)
*
* Returns: The head of the queue
*
* Since: 1.2.0
* Since: 1.2
*/
gpointer
gst_queue_array_peek_head (GstQueueArray * array)
@ -137,7 +137,7 @@ gst_queue_array_peek_head (GstQueueArray * array)
*
* Pushes @data to the tail of the queue @array.
*
* Since: 1.2.0
* Since: 1.2
*/
void
gst_queue_array_push_tail (GstQueueArray * array, gpointer data)
@ -190,7 +190,7 @@ gst_queue_array_push_tail (GstQueueArray * array, gpointer data)
*
* Returns: %TRUE if the queue @array is empty
*
* Since: 1.2.0
* Since: 1.2
*/
gboolean
gst_queue_array_is_empty (GstQueueArray * array)
@ -207,7 +207,7 @@ gst_queue_array_is_empty (GstQueueArray * array)
*
* Returns: the dropped element
*
* Since: 1.2.0
* Since: 1.2
*/
gpointer
gst_queue_array_drop_element (GstQueueArray * array, guint idx)
@ -301,7 +301,7 @@ gst_queue_array_drop_element (GstQueueArray * array, guint idx)
*
* Returns: Index of the found element or -1 if nothing was found.
*
* Since: 1.2.0
* Since: 1.2
*/
guint
gst_queue_array_find (GstQueueArray * array, GCompareFunc func, gpointer data)
@ -332,7 +332,7 @@ gst_queue_array_find (GstQueueArray * array, GCompareFunc func, gpointer data)
*
* Returns: the length of the queue @array.
*
* Since: 1.2.0
* Since: 1.2
*/
guint
gst_queue_array_get_length (GstQueueArray * array)