docs: don't put random stuff in tags.
authorStefan Kost <ensonic@users.sf.net>
Thu, 26 Feb 2009 07:35:43 +0000 (09:35 +0200)
committerStefan Kost <ensonic@users.sf.net>
Thu, 26 Feb 2009 08:09:59 +0000 (10:09 +0200)
Tags like Since: or Returns: can only be followed by more tags. gtk-doc has no
tag to append text again to the documentation body.

gst-libs/gst/app/gstappsink.c
gst-libs/gst/app/gstappsrc.c
gst-libs/gst/audio/gstaudiofilter.c
gst-libs/gst/audio/gstringbuffer.c
gst-libs/gst/rtp/gstrtcpbuffer.c

index 183c7f0..8e18336 100644 (file)
@@ -72,9 +72,9 @@
  * The eos signal can also be used to be informed when the EOS state is reached
  * to avoid polling.
  *
- * Since: 0.10.22
- *
  * Last reviewed on 2008-12-17 (0.10.22)
+ *
+ * Since: 0.10.22
  */
 
 #ifdef HAVE_CONFIG_H
index 69b37e6..aa7bb25 100644 (file)
  * gst_app_src_end_of_stream() or emit the end-of-stream action signal. After
  * this call, no more buffers can be pushed into appsrc until a flushing seek
  * happened or the state of the appsrc has gone through READY.
- * 
- * Since: 0.10.22
  *
  * Last reviewed on 2008-12-17 (0.10.10)
+ *
+ * Since: 0.10.22
  */
 
 #ifdef HAVE_CONFIG_H
index 6a2323e..9c329bf 100644 (file)
@@ -37,9 +37,9 @@
  * #GstBaseTransformClass.transform()
  * virtual functions in their class_init function.
  *
- * Since: 0.10.12
- *
  * Last reviewed on 2007-02-03 (0.10.11.1)
+ *
+ * Since: 0.10.12
  */
 
 #ifdef HAVE_CONFIG_H
index e9023c8..24bbda4 100644 (file)
@@ -901,12 +901,12 @@ gst_ring_buffer_is_acquired (GstRingBuffer * buf)
  *
  * Activate @buf to start or stop pulling data.
  *
+ * MT safe.
+ *
  * Returns: TRUE if the device could be activated in the requested mode,
  * FALSE on error.
  *
  * Since: 0.10.22.
- *
- * MT safe.
  */
 gboolean
 gst_ring_buffer_activate (GstRingBuffer * buf, gboolean active)
@@ -970,11 +970,11 @@ activate_failed:
  *
  * Check if @buf is activated.
  *
+ * MT safe.
+ *
  * Returns: TRUE if the device is active.
  *
  * Since: 0.10.22.
- *
- * MT safe.
  */
 gboolean
 gst_ring_buffer_is_active (GstRingBuffer * buf)
@@ -1552,13 +1552,13 @@ G_STMT_START {                                  \
  * interrupted, one can resume the processing by passing the previously returned
  * @accum value back to this function.
  *
+ * MT safe.
+ *
  * Returns: The number of samples written to the ringbuffer or -1 on error. The
  * number of samples written can be less than @out_samples when @buf was interrupted
  * with a flush or stop.
  *
  * Since: 0.10.11.
- *
- * MT safe.
  */
 guint
 gst_ring_buffer_commit_full (GstRingBuffer * buf, guint64 * sample,
@@ -1956,9 +1956,9 @@ gst_ring_buffer_clear (GstRingBuffer * buf, gint segment)
  * Tell the ringbuffer that it is allowed to start playback when
  * the ringbuffer is filled with samples. 
  *
- * Since: 0.10.6
- *
  * MT safe.
+ *
+ * Since: 0.10.6
  */
 void
 gst_ring_buffer_may_start (GstRingBuffer * buf, gboolean allowed)
index b7172c6..ab77c8a 100644 (file)
@@ -41,9 +41,9 @@
  * </para>
  * </refsect2>
  *
- * Since: 0.10.13
- *
  * Last reviewed on 2007-03-26 (0.10.13)
+ *
+ * Since: 0.10.13
  */
 
 #include <string.h>