collectpads2: move "MT save" tags to doc body

It is not useful to have "MT safe" tags randomly in body, returns or since paragraphs.
This commit is contained in:
Stefan Sauer 2012-02-26 22:57:02 +01:00
parent 4594e4311d
commit b9a6b3fc6e

View file

@ -278,10 +278,10 @@ gst_collect_pads2_finalize (GObject * object)
* *
* Create a new instance of #GstCollectsPads. * Create a new instance of #GstCollectsPads.
* *
* Returns: a new #GstCollectPads2, or NULL in case of an error.
*
* MT safe. * MT safe.
* *
* Returns: a new #GstCollectPads2, or NULL in case of an error.
*
* Since: 0.10.36 * Since: 0.10.36
*/ */
GstCollectPads2 * GstCollectPads2 *
@ -533,11 +533,11 @@ gst_collect_pads2_set_clip_function (GstCollectPads2 * pads,
* This function calls gst_collect_pads2_add_pad() passing a value of NULL * This function calls gst_collect_pads2_add_pad() passing a value of NULL
* for destroy_notify and TRUE for locked. * for destroy_notify and TRUE for locked.
* *
* MT safe.
*
* Returns: a new #GstCollectData2 to identify the new pad. Or NULL * Returns: a new #GstCollectData2 to identify the new pad. Or NULL
* if wrong parameters are supplied. * if wrong parameters are supplied.
* *
* MT safe.
*
* Since: 0.10.36 * Since: 0.10.36
*/ */
GstCollectData2 * GstCollectData2 *
@ -579,12 +579,12 @@ gst_collect_pads2_add_pad (GstCollectPads2 * pads, GstPad * pad, guint size)
* The pad will be automatically activated in push mode when @pads is * The pad will be automatically activated in push mode when @pads is
* started. * started.
* *
* MT safe.
*
* Since: 0.10.36 * Since: 0.10.36
* *
* Returns: a new #GstCollectData2 to identify the new pad. Or NULL * Returns: a new #GstCollectData2 to identify the new pad. Or NULL
* if wrong parameters are supplied. * if wrong parameters are supplied.
*
* MT safe.
*/ */
GstCollectData2 * GstCollectData2 *
gst_collect_pads2_add_pad_full (GstCollectPads2 * pads, GstPad * pad, gst_collect_pads2_add_pad_full (GstCollectPads2 * pads, GstPad * pad,
@ -655,10 +655,10 @@ find_pad (GstCollectData2 * data, GstPad * pad)
* *
* The pad will be deactivated automatically when @pads is stopped. * The pad will be deactivated automatically when @pads is stopped.
* *
* Returns: %TRUE if the pad could be removed.
*
* MT safe. * MT safe.
* *
* Returns: %TRUE if the pad could be removed.
*
* Since: 0.10.36 * Since: 0.10.36
*/ */
gboolean gboolean
@ -742,10 +742,10 @@ unknown_pad:
* *
* This function is currently not implemented. * This function is currently not implemented.
* *
* Returns: %TRUE if the pad is active.
*
* MT safe. * MT safe.
* *
* Returns: %TRUE if the pad is active.
*
* Since: 0.10.36 * Since: 0.10.36
*/ */
gboolean gboolean
@ -770,10 +770,10 @@ gst_collect_pads2_is_active (GstCollectPads2 * pads, GstPad * pad)
* *
* This function is currently not implemented. * This function is currently not implemented.
* *
* Returns: #GstFlowReturn of the operation.
*
* MT safe. * MT safe.
* *
* Returns: #GstFlowReturn of the operation.
*
* Since: 0.10.36 * Since: 0.10.36
*/ */
GstFlowReturn GstFlowReturn
@ -798,10 +798,10 @@ gst_collect_pads2_collect (GstCollectPads2 * pads)
* *
* This function is currently not implemented. * This function is currently not implemented.
* *
* Returns: #GstFlowReturn of the operation.
*
* MT safe. * MT safe.
* *
* Returns: #GstFlowReturn of the operation.
*
* Since: 0.10.36 * Since: 0.10.36
*/ */
GstFlowReturn GstFlowReturn
@ -861,7 +861,6 @@ gst_collect_pads2_set_flushing_unlocked (GstCollectPads2 * pads,
* *
* MT safe. * MT safe.
* *
*
* Since: 0.10.36 * Since: 0.10.36
*/ */
void void
@ -988,11 +987,11 @@ gst_collect_pads2_stop (GstCollectPads2 * pads)
* should be called with the @pads STREAM_LOCK held, such as in the callback * should be called with the @pads STREAM_LOCK held, such as in the callback
* handler. * handler.
* *
* MT safe.
*
* Returns: The buffer in @data or NULL if no buffer is queued. * Returns: The buffer in @data or NULL if no buffer is queued.
* should unref the buffer after usage. * should unref the buffer after usage.
* *
* MT safe.
*
* Since: 0.10.36 * Since: 0.10.36
*/ */
GstBuffer * GstBuffer *
@ -1022,11 +1021,11 @@ gst_collect_pads2_peek (GstCollectPads2 * pads, GstCollectData2 * data)
* should be called with the @pads STREAM_LOCK held, such as in the callback * should be called with the @pads STREAM_LOCK held, such as in the callback
* handler. * handler.
* *
* MT safe.
*
* Returns: The buffer in @data or NULL if no buffer was queued. * Returns: The buffer in @data or NULL if no buffer was queued.
* You should unref the buffer after usage. * You should unref the buffer after usage.
* *
* MT safe.
*
* Since: 0.10.36 * Since: 0.10.36
*/ */
GstBuffer * GstBuffer *
@ -1076,11 +1075,11 @@ gst_collect_pads2_clear (GstCollectPads2 * pads, GstCollectData2 * data)
* This function should be called with @pads STREAM_LOCK held, such as * This function should be called with @pads STREAM_LOCK held, such as
* in the callback. * in the callback.
* *
* MT safe.
*
* Returns: The maximum number of bytes queued on all pads. This function * Returns: The maximum number of bytes queued on all pads. This function
* returns 0 if a pad has no queued buffer. * returns 0 if a pad has no queued buffer.
* *
* MT safe.
*
* Since: 0.10.36 * Since: 0.10.36
*/ */
/* we might pre-calculate this in some struct field, /* we might pre-calculate this in some struct field,
@ -1149,12 +1148,12 @@ not_filled:
* This function should be called with @pads STREAM_LOCK held, such as * This function should be called with @pads STREAM_LOCK held, such as
* in the callback. * in the callback.
* *
* MT safe.
*
* Returns: The number of bytes available for consumption in the * Returns: The number of bytes available for consumption in the
* memory pointed to by @bytes. This can be less than @size and * memory pointed to by @bytes. This can be less than @size and
* is 0 if the pad is end-of-stream. * is 0 if the pad is end-of-stream.
* *
* MT safe.
*
* Since: 0.10.36 * Since: 0.10.36
*/ */
guint guint
@ -1191,11 +1190,11 @@ gst_collect_pads2_read (GstCollectPads2 * pads, GstCollectData2 * data,
* This function should be called with @pads STREAM_LOCK held, such as * This function should be called with @pads STREAM_LOCK held, such as
* in the callback. * in the callback.
* *
* MT safe.
*
* Returns: The number of bytes flushed This can be less than @size and * Returns: The number of bytes flushed This can be less than @size and
* is 0 if the pad was end-of-stream. * is 0 if the pad was end-of-stream.
* *
* MT safe.
*
* Since: 0.10.36 * Since: 0.10.36
*/ */
guint guint
@ -1236,13 +1235,13 @@ gst_collect_pads2_flush (GstCollectPads2 * pads, GstCollectData2 * data,
* This function should be called with @pads STREAM_LOCK held, such as in the * This function should be called with @pads STREAM_LOCK held, such as in the
* callback. * callback.
* *
* MT safe.
*
* Since: 0.10.36 * Since: 0.10.36
* *
* Returns: A sub buffer. The size of the buffer can be less that requested. * Returns: A sub buffer. The size of the buffer can be less that requested.
* A return of NULL signals that the pad is end-of-stream. * A return of NULL signals that the pad is end-of-stream.
* Unref the buffer after use. * Unref the buffer after use.
*
* MT safe.
*/ */
GstBuffer * GstBuffer *
gst_collect_pads2_read_buffer (GstCollectPads2 * pads, GstCollectData2 * data, gst_collect_pads2_read_buffer (GstCollectPads2 * pads, GstCollectData2 * data,
@ -1276,13 +1275,13 @@ gst_collect_pads2_read_buffer (GstCollectPads2 * pads, GstCollectData2 * data,
* This function should be called with @pads STREAM_LOCK held, such as in the * This function should be called with @pads STREAM_LOCK held, such as in the
* callback. * callback.
* *
* MT safe.
*
* Since: 0.10.36 * Since: 0.10.36
* *
* Returns: A sub buffer. The size of the buffer can be less that requested. * Returns: A sub buffer. The size of the buffer can be less that requested.
* A return of NULL signals that the pad is end-of-stream. * A return of NULL signals that the pad is end-of-stream.
* Unref the buffer after use. * Unref the buffer after use.
*
* MT safe.
*/ */
GstBuffer * GstBuffer *
gst_collect_pads2_take_buffer (GstCollectPads2 * pads, GstCollectData2 * data, gst_collect_pads2_take_buffer (GstCollectPads2 * pads, GstCollectData2 * data,