doc: Unify Since mark for attribute and enum
authorNicolas Dufresne <nicolas.dufresne@collabora.co.uk>
Thu, 18 Jun 2015 15:51:48 +0000 (11:51 -0400)
committerNicolas Dufresne <nicolas.dufresne@collabora.co.uk>
Thu, 18 Jun 2015 15:51:48 +0000 (11:51 -0400)
As this show up as prose in the doc, simply make it consistent
and "arguable" nicer to read.

gst/gstbuffer.c
gst/gstelementfactory.h
gst/gstsegment.h
gst/gstsystemclock.h
libs/gst/base/gstbasetransform.h

index 025e867..f86df33 100644 (file)
  * 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"
index b7ea495..17e55ce 100644 (file)
@@ -88,8 +88,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
index f0f7af5..da3942f 100644 (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 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
  *
@@ -143,12 +143,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
  *
index fe5d009..c142708 100644 (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.
  */
index c69ba6e..84dab80 100644 (file)
@@ -198,7 +198,7 @@ struct _GstBaseTransform {
  *                  member variable. If the buffer is dropped due to QoS, it returns
  *                  GST_BASE_TRANSFORM_FLOW_DROPPED. If this input buffer is not
  *                  contiguous with any previous input buffer, then @is_discont
- *                  is set to #TRUE. (Since: 1.6)
+ *                  is set to #TRUE. (Since 1.6)
  * @generate_output: Called after each new input buffer is submitted repeatedly
  *                   until it either generates an error or fails to generate an output
  *                   buffer. The default implementation takes the contents of the
@@ -207,7 +207,7 @@ struct _GstBaseTransform {
  *                   calls either @transform or @transform_ip. Elements that don't
  *                   do 1-to-1 transformations on input to output buffers can either
  *                   return GST_BASE_TRANSFORM_FLOW_DROPPED or simply not generate
- *                   an output buffer until they are ready to do so. (Since: 1.6)
+ *                   an output buffer until they are ready to do so. (Since 1.6)
  *                   
  * Subclasses can override any of the available virtual methods or not, as
  * needed. At minimum either @transform or @transform_ip need to be overridden.