doc: Fix Since: marks

There was few Since: mark missing their column. Also unify the way we set the Since mark on enum value and structure members. These sadly don't show up in the index.
2025-03-28 20:05:38 +00:00 · 2015-06-13 20:19:59 -04:00 · 2015-06-13 20:19:59 -04:00 · bd9ea8d18f
commit bd9ea8d18f
parent b3f42b0c35
11 changed files with 22 additions and 22 deletions
--- a/gst/gstallocator.h
+++ b/gst/gstallocator.h
@ -98,9 +98,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.
 */
--- a/gst/gstbuffer.c
+++ b/gst/gstbuffer.c
@ -580,7 +580,7 @@ _gst_buffer_copy (const GstBuffer * buffer)
 *
 * Returns: (transfer full): a new copy of @buf.
 *
- * Since 1.6
+ * Since: 1.6
 */
 GstBuffer *
 gst_buffer_copy_deep (const GstBuffer * buffer)
--- a/gst/gstbuffer.h
+++ b/gst/gstbuffer.h
@ -196,7 +196,7 @@ 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_LAST:        additional media specific flags can be added starting from
 *                               this flag.
 *
--- a/gst/gstbufferpool.h
+++ b/gst/gstbufferpool.h
@ -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.
 */
--- a/gst/gstclock.h
+++ b/gst/gstclock.h
@ -88,7 +88,7 @@ typedef gpointer GstClockID;
 *
 * Tests if a given #GstClockTimeDiff of #gint64 represents a valid defined time.
 *
- * Since 1.6
+ * Since: 1.6
 */
 #define GST_CLOCK_STIME_IS_VALID(time)   (((GstClockTimeDiff)(time)) != GST_CLOCK_STIME_NONE)

@ -251,7 +251,7 @@ G_STMT_START {                                                    \
 * printf("%" GST_STIME_FORMAT "\n", GST_STIME_ARGS(ts));
 * ]|
 *
- * Since 1.6
+ * Since: 1.6
 */
 #define GST_STIME_FORMAT "d:%02u:%02u.%09u"
 /**
@ -261,7 +261,7 @@ G_STMT_START {                                                    \
 * Format @t for the #GST_STIME_FORMAT format string. Note: @t will be
 * evaluated more than once.
 *
- * Since 1.6
+ * Since: 1.6
 */
 #define GST_STIME_ARGS(t) \
        GST_CLOCK_STIME_IS_VALID (t) ? \
@ -410,7 +410,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
--- a/gst/gsterror.h
+++ b/gst/gsterror.h
@ -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:
--- a/gst/gstmemory.h
+++ b/gst/gstmemory.h
@ -46,8 +46,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 2.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.
--- a/gst/gstmessage.h
+++ b/gst/gstmessage.h
@ -197,7 +197,7 @@ GST_EXPORT GType _gst_message_type;
 * @message: a #GstMessage
 *
 * Check if the message is in the extended message group
- * (Since 1.4)
+ * Since: 1.4
 */
 #define GST_MESSAGE_TYPE_IS_EXTENDED(message)       (!!(GST_MESSAGE_CAST(message)->type & GST_MESSAGE_EXTENDED))

--- a/gst/gstprotection.h
+++ b/gst/gstprotection.h
@ -30,7 +30,7 @@ G_BEGIN_DECLS
 * The field name in a GstCaps that is used to signal the UUID of the protection
 * system.
 *
- * Since 1.6
+ * Since: 1.6
 */
 #define GST_PROTECTION_SYSTEM_ID_CAPS_FIELD "protection-system"

@ -43,7 +43,7 @@ typedef struct _GstProtectionMeta GstProtectionMeta;
 * Metadata type that holds information about a sample from a protection-protected
 * track, including the information needed to decrypt it (if it is encrypted).
 *
- * Since 1.6
+ * Since: 1.6
 */
 struct _GstProtectionMeta
 {
--- a/libs/gst/base/gstcollectpads.h
+++ b/libs/gst/base/gstcollectpads.h
@ -114,7 +114,7 @@ typedef enum {
 * be negative. If the initial DTS was not set, this value will be
 * set to %G_MININT64.
 *
- * Since 1.6
+ * Since: 1.6
 */
 #define GST_COLLECT_PADS_DTS(data)                   (((GstCollectData *) data)->ABI.abi.dts)

@ -124,7 +124,7 @@ typedef enum {
 *
 * Check if running DTS value store is valid.
 *
- * Since 1.6
+ * Since: 1.6
 */
 #define GST_COLLECT_PADS_DTS_IS_VALID(data)          (GST_CLOCK_STIME_IS_VALID (GST_COLLECT_PADS_DTS (data)))

@ -135,7 +135,7 @@ typedef enum {
 * @buffer: currently queued buffer.
 * @pos: position in the buffer
 * @segment: last segment received.
- * @dts: the signed version of the DTS converted to running time. Since 1.6
+ * @dts: the signed version of the DTS converted to running time. (Since 1.6)
 *
 * Structure used by the collect_pads.
 */
--- a/libs/gst/controller/gsttimedvaluecontrolsource.c
+++ b/libs/gst/controller/gsttimedvaluecontrolsource.c
@ -483,7 +483,7 @@ gst_timed_value_control_source_class_init (GstTimedValueControlSourceClass
   *
   * Emited right after the new value has been set on @timed_signals
   *
-   * Since 1.6
+   * Since: 1.6
   */
  gst_timed_value_control_source_signals[VALUE_CHANGED_SIGNAL] =
      g_signal_new ("value-changed", G_TYPE_FROM_CLASS (klass),
@ -499,7 +499,7 @@ gst_timed_value_control_source_class_init (GstTimedValueControlSourceClass
   *
   * Emited right after the new value has been added to @self
   *
-   * Since 1.6
+   * Since: 1.6
   */
  gst_timed_value_control_source_signals[VALUE_ADDED_SIGNAL] =
      g_signal_new ("value-added", G_TYPE_FROM_CLASS (klass),
@ -515,7 +515,7 @@ gst_timed_value_control_source_class_init (GstTimedValueControlSourceClass
   *
   * Emited when @timed_value is removed from @self
   *
-   * Since 1.6
+   * Since: 1.6
   */
  gst_timed_value_control_source_signals[VALUE_REMOVED_SIGNAL] =
      g_signal_new ("value-removed", G_TYPE_FROM_CLASS (klass),