libs: Fix various Since markers
authorSebastian Dröge <sebastian@centricular.com>
Tue, 23 Apr 2019 12:05:43 +0000 (15:05 +0300)
committerTim-Philipp Müller <tim@centricular.com>
Tue, 6 Aug 2019 23:12:35 +0000 (00:12 +0100)
19 files changed:
gst-libs/gst/audio/audio-channels.c
gst-libs/gst/audio/gstaudiodecoder.h
gst-libs/gst/audio/gstaudioencoder.h
gst-libs/gst/audio/gstaudioringbuffer.h
gst-libs/gst/pbutils/codec-utils.c
gst-libs/gst/pbutils/encoding-profile.c
gst-libs/gst/rtsp/gstrtspconnection.c
gst-libs/gst/rtsp/gstrtspconnection.h
gst-libs/gst/rtsp/gstrtspdefs.c
gst-libs/gst/rtsp/gstrtspdefs.h
gst-libs/gst/sdp/gstmikey.h
gst-libs/gst/video/gstvideodecoder.h
gst-libs/gst/video/gstvideoencoder.c
gst-libs/gst/video/gstvideoencoder.h
gst-libs/gst/video/navigation.h
gst-libs/gst/video/video-format.h
gst-libs/gst/video/video-info.h
gst-libs/gst/video/video-resampler.h
gst-libs/gst/video/videooverlay.c

index f713bbc..8f18c28 100644 (file)
@@ -675,7 +675,7 @@ position_to_string (GstAudioChannelPosition pos)
  * Returns: (transfer full): a newly allocated string representing
  * @position
  *
- * Since 1.10
+ * Since: 1.10
  */
 gchar *
 gst_audio_channel_positions_to_string (const GstAudioChannelPosition * position,
index 0dfbf11..841cb88 100644 (file)
@@ -237,12 +237,12 @@ struct _GstAudioDecoder
  *                  Query handler on the sink pad. This function should
  *                  return TRUE if the query could be performed. Subclasses
  *                  should chain up to the parent implementation to invoke the
- *                  default handler. Since 1.6
+ *                  default handler. Since: 1.6
  * @src_query:      Optional.
  *                  Query handler on the source pad. This function should
  *                  return TRUE if the query could be performed. Subclasses
  *                  should chain up to the parent implementation to invoke the
- *                  default handler. Since 1.6
+ *                  default handler. Since: 1.6
  * @getcaps:        Optional.
  *                  Allows for a custom sink getcaps implementation.
  *                  If not implemented,
@@ -252,7 +252,7 @@ struct _GstAudioDecoder
  *                  output buffer. By default this method copies all meta without
  *                  tags and meta with only the "audio" tag. subclasses can
  *                  implement this method and return %TRUE if the metadata is to be
- *                  copied. Since 1.6
+ *                  copied. Since: 1.6
  *
  * Subclasses can override any of the available virtual methods or not, as
  * needed. At minimum @handle_frame (and likely @set_format) needs to be
index 348b70e..e33f6c8 100644 (file)
@@ -178,17 +178,17 @@ struct _GstAudioEncoder {
  *                  output buffer. By default this method copies all meta without
  *                  tags and meta with only the "audio" tag. subclasses can
  *                  implement this method and return %TRUE if the metadata is to be
- *                  copied. Since 1.6
+ *                  copied. Since: 1.6
  * @sink_query:     Optional.
  *                  Query handler on the sink pad. This function should
  *                  return TRUE if the query could be performed. Subclasses
  *                  should chain up to the parent implementation to invoke the
- *                  default handler. Since 1.6
+ *                  default handler. Since: 1.6
  * @src_query:      Optional.
  *                  Query handler on the source pad. This function should
  *                  return TRUE if the query could be performed. Subclasses
  *                  should chain up to the parent implementation to invoke the
- *                  default handler. Since 1.6
+ *                  default handler. Since: 1.6
  *
  * Subclasses can override any of the available virtual methods or not, as
  * needed. At minimum @set_format and @handle_frame needs to be overridden.
index 3313ff6..76d2be4 100644 (file)
@@ -60,7 +60,7 @@ typedef void (*GstAudioRingBufferCallback) (GstAudioRingBuffer *rbuf, guint8* da
  * @GST_AUDIO_RING_BUFFER_STATE_STARTED: The ringbuffer is started
  * @GST_AUDIO_RING_BUFFER_STATE_ERROR: The ringbuffer has encountered an
  *     error after it has been started, e.g. because the device was
- *     disconnected (Since 1.2)
+ *     disconnected (Since: 1.2)
  *
  * The state of the ringbuffer.
  */
@@ -85,9 +85,9 @@ typedef enum {
  * @GST_AUDIO_RING_BUFFER_FORMAT_TYPE_DTS: samples in DTS format
  * @GST_AUDIO_RING_BUFFER_FORMAT_TYPE_MPEG2_AAC: samples in MPEG-2 AAC ADTS format
  * @GST_AUDIO_RING_BUFFER_FORMAT_TYPE_MPEG4_AAC: samples in MPEG-4 AAC ADTS format
- * @GST_AUDIO_RING_BUFFER_FORMAT_TYPE_MPEG2_AAC_RAW: samples in MPEG-2 AAC raw format (Since 1.12)
- * @GST_AUDIO_RING_BUFFER_FORMAT_TYPE_MPEG4_AAC_RAW: samples in MPEG-4 AAC raw format (Since 1.12)
- * @GST_AUDIO_RING_BUFFER_FORMAT_TYPE_FLAC: samples in FLAC format (Since 1.12)
+ * @GST_AUDIO_RING_BUFFER_FORMAT_TYPE_MPEG2_AAC_RAW: samples in MPEG-2 AAC raw format (Since: 1.12)
+ * @GST_AUDIO_RING_BUFFER_FORMAT_TYPE_MPEG4_AAC_RAW: samples in MPEG-4 AAC raw format (Since: 1.12)
+ * @GST_AUDIO_RING_BUFFER_FORMAT_TYPE_FLAC: samples in FLAC format (Since: 1.12)
  *
  * The format of the samples in the ringbuffer.
  */
index a8b14fe..03a2c94 100644 (file)
@@ -197,7 +197,7 @@ gst_codec_utils_aac_get_audio_object_type_full (GstBitReader * br,
  *
  * Returns: The sample rate if sr_idx is valid, 0 otherwise.
  *
- * Since 1.10
+ * Since: 1.10
  */
 guint
 gst_codec_utils_aac_get_sample_rate (const guint8 * audio_config, guint len)
@@ -226,7 +226,7 @@ gst_codec_utils_aac_get_sample_rate (const guint8 * audio_config, guint len)
  *
  * Returns: The channels or 0 if the channel could not be determined.
  *
- * Since 1.10
+ * Since: 1.10
  */
 guint
 gst_codec_utils_aac_get_channels (const guint8 * audio_config, guint len)
@@ -824,7 +824,7 @@ gst_codec_utils_h264_caps_set_level_and_profile (GstCaps * caps,
  *
  * Returns: The profile as a const string, or %NULL if there is an error.
  *
- * Since 1.4
+ * Since: 1.4
  */
 const gchar *
 gst_codec_utils_h265_get_profile (const guint8 * profile_tier_level, guint len)
@@ -865,7 +865,7 @@ gst_codec_utils_h265_get_profile (const guint8 * profile_tier_level, guint len)
  *
  * Returns: The tier as a const string, or %NULL if there is an error.
  *
- * Since 1.4
+ * Since: 1.4
  */
 const gchar *
 gst_codec_utils_h265_get_tier (const guint8 * profile_tier_level, guint len)
@@ -902,7 +902,7 @@ gst_codec_utils_h265_get_tier (const guint8 * profile_tier_level, guint len)
  *
  * Returns: The level as a const string, or %NULL if there is an error.
  *
- * Since 1.4
+ * Since: 1.4
  */
 const gchar *
 gst_codec_utils_h265_get_level (const guint8 * profile_tier_level, guint len)
@@ -955,7 +955,7 @@ gst_codec_utils_h265_get_level (const guint8 * profile_tier_level, guint len)
  *
  * Returns: the level_idc or 0 if the level is unknown
  *
- * Since 1.4
+ * Since: 1.4
  */
 guint8
 gst_codec_utils_h265_get_level_idc (const gchar * level)
@@ -1007,7 +1007,7 @@ gst_codec_utils_h265_get_level_idc (const gchar * level)
  *
  * Returns: %TRUE if the level, tier, profile could be set, %FALSE otherwise.
  *
- * Since 1.4
+ * Since: 1.4
  */
 gboolean
 gst_codec_utils_h265_caps_set_level_tier_and_profile (GstCaps * caps,
index e72de83..6232b4c 100644 (file)
@@ -576,7 +576,7 @@ gst_encoding_profile_get_presence (GstEncodingProfile * profile)
  *
  * Returns: Whther @profile is enabled or not
  *
- * Since 1.6
+ * Since: 1.6
  */
 gboolean
 gst_encoding_profile_is_enabled (GstEncodingProfile * profile)
@@ -750,7 +750,7 @@ gst_encoding_profile_set_presence (GstEncodingProfile * profile, guint presence)
  *
  * Set whether the profile should be used or not.
  *
- * Since 1.6
+ * Since: 1.6
  */
 void
 gst_encoding_profile_set_enabled (GstEncodingProfile * profile,
@@ -1991,7 +1991,7 @@ gst_encoding_profile_from_discoverer (GstDiscovererInfo * info)
  *
  * Returns: (transfer full): The copy of @self
  *
- * Since 1.12
+ * Since: 1.12
  */
 GstEncodingProfile *
 gst_encoding_profile_copy (GstEncodingProfile * self)
index dba9b7b..b97aef6 100644 (file)
@@ -963,7 +963,7 @@ remote_address_failed:
  *
  * Returns: #GST_RTSP_OK when a connection could be made.
  *
- * Since 1.8
+ * Since: 1.8
  */
 GstRTSPResult
 gst_rtsp_connection_connect_with_response (GstRTSPConnection * conn,
index b27f813..38b8e57 100644 (file)
@@ -256,7 +256,7 @@ typedef struct _GstRTSPWatch GstRTSPWatch;
  * @tunnel_lost: callback when the post connection of a tunnel is closed.
  * @tunnel_http_response: callback when an HTTP response to the GET request
  *   is about to be sent for a tunneled connection. The response can be
- *   modified in the callback. Since 1.4.
+ *   modified in the callback. Since: 1.4.
  *
  * Callback functions from a #GstRTSPWatch.
  */
index f1d7999..0066a22 100644 (file)
@@ -174,10 +174,10 @@ static struct rtsp_header rtsp_headers[] = {
 
   {"RTCP-Interval", FALSE},
 
-  /* Since 1.4 */
+  /* Since: 1.4 */
   {"KeyMgmt", FALSE},
 
-  /* Since 1.14 */
+  /* Since: 1.14 */
   {"Pipelined-Requests", FALSE},
   {"Media-Properties", FALSE},
   {"Seek-Style", FALSE},
index 466842d..c35e2b3 100644 (file)
@@ -332,10 +332,10 @@ typedef enum {
 
   GST_RTSP_HDR_RTCP_INTERVAL,       /* RTCP-Interval */
 
-  /* Since 1.4 */
+  /* Since: 1.4 */
   GST_RTSP_HDR_KEYMGMT,             /* KeyMgmt */
 
-  /* Since 1.14 */
+  /* Since: 1.14 */
   GST_RTSP_HDR_PIPELINED_REQUESTS,  /* Pipelined-Requests Rr     opt.      SETUP */
   GST_RTSP_HDR_MEDIA_PROPERTIES,    /* Media-Properties   Rr     opt.      SETUP */
   GST_RTSP_HDR_SEEK_STYLE,          /* Seek-Type          Rr     opt.      PLAY */
index aca10fd..dd482cc 100644 (file)
@@ -219,7 +219,7 @@ gst_mikey_payload_copy (const GstMIKEYPayload * payload)
  * @GST_MIKEY_ENC_NULL: no encryption
  * @GST_MIKEY_ENC_AES_CM_128: AES-CM using a 128-bit key
  * @GST_MIKEY_ENC_AES_KW_128: AES Key Wrap using a 128-bit key
- * @GST_MIKEY_ENC_AES_GCM_128: AES-GCM using a 128-bit key (Since 1.16)
+ * @GST_MIKEY_ENC_AES_GCM_128: AES-GCM using a 128-bit key (Since: 1.16)
  *
  * The encryption algorithm used to encrypt the Encr data field
  */
@@ -395,7 +395,7 @@ typedef enum
  * @GST_MIKEY_SP_SRTP_SRTP_AUTH: SRTP authentication off/on, 0 if off, 1 if on
  * @GST_MIKEY_SP_SRTP_AUTH_TAG_LEN: Authentication tag length
  * @GST_MIKEY_SP_SRTP_SRTP_PREFIX_LEN: SRTP prefix length
- * @GST_MIKEY_SP_SRTP_AEAD_AUTH_TAG_LEN: AEAD authentication tag length (Since 1.16)
+ * @GST_MIKEY_SP_SRTP_AEAD_AUTH_TAG_LEN: AEAD authentication tag length (Since: 1.16)
  *
  * This policy specifies the parameters for SRTP and SRTCP
  */
index 17048cf..d77a7c9 100644 (file)
@@ -256,12 +256,12 @@ struct _GstVideoDecoder
  *                  Query handler on the sink pad. This function should
  *                  return TRUE if the query could be performed. Subclasses
  *                  should chain up to the parent implementation to invoke the
- *                  default handler. Since 1.4
+ *                  default handler. Since: 1.4
  * @src_query:      Optional.
  *                  Query handler on the source pad. This function should
  *                  return TRUE if the query could be performed. Subclasses
  *                  should chain up to the parent implementation to invoke the
- *                  default handler. Since 1.4
+ *                  default handler. Since: 1.4
  * @getcaps:        Optional.
  *                  Allows for a custom sink getcaps implementation.
  *                  If not implemented, default returns
@@ -271,7 +271,7 @@ struct _GstVideoDecoder
  *                  output buffer. By default this method is copies all meta without
  *                  tags and meta with only the "video" tag. subclasses can
  *                  implement this method and return %TRUE if the metadata is to be
- *                  copied. Since 1.6
+ *                  copied. Since: 1.6
  *
  * Subclasses can override any of the available virtual methods or not, as
  * needed. At minimum @handle_frame needs to be overridden, and @set_format
index 400be26..3205d26 100644 (file)
@@ -2641,7 +2641,7 @@ gst_video_encoder_get_allocator (GstVideoEncoder * encoder,
  * For streams with reordered frames this can be used to ensure that there
  * is enough time to accomodate first DTS, which may be less than first PTS
  *
- * Since 1.6
+ * Since: 1.6
  */
 void
 gst_video_encoder_set_min_pts (GstVideoEncoder * encoder, GstClockTime min_pts)
index 21d955e..24ea7ed 100644 (file)
@@ -223,17 +223,17 @@ struct _GstVideoEncoder
  *                  Query handler on the sink pad. This function should
  *                  return TRUE if the query could be performed. Subclasses
  *                  should chain up to the parent implementation to invoke the
- *                  default handler. Since 1.4
+ *                  default handler. Since: 1.4
  * @src_query:      Optional.
  *                  Query handler on the source pad. This function should
  *                  return TRUE if the query could be performed. Subclasses
  *                  should chain up to the parent implementation to invoke the
- *                  default handler. Since 1.4
+ *                  default handler. Since: 1.4
  * @transform_meta: Optional. Transform the metadata on the input buffer to the
  *                  output buffer. By default this method is copies all meta without
  *                  tags and meta with only the "video" tag. subclasses can
  *                  implement this method and return %TRUE if the metadata is to be
- *                  copied. Since 1.6
+ *                  copied. Since: 1.6
  *
  * Subclasses can override any of the available virtual methods or not, as
  * needed. At minimum @handle_frame needs to be overridden, and @set_format
index ce08258..0f9a3b3 100644 (file)
@@ -196,7 +196,7 @@ gboolean        gst_navigation_query_parse_angles       (GstQuery *query, guint
  * feature (such as a multiangle DVD) change - either angles have appeared or
  * disappeared.
  * @GST_NAVIGATION_MESSAGE_EVENT: Sent when a navigation event was not handled
- * by any element in the pipeline (Since 1.6)
+ * by any element in the pipeline (Since: 1.6)
  *
  * A set of notifications that may be received on the bus when navigation
  * related status changes.
index 5beb3b2..30189b2 100644 (file)
@@ -64,7 +64,7 @@ G_BEGIN_DECLS
  * @GST_VIDEO_FORMAT_GRAY16_BE: 16-bit grayscale, most significant byte first
  * @GST_VIDEO_FORMAT_GRAY16_LE: 16-bit grayscale, least significant byte first
  * @GST_VIDEO_FORMAT_v308: packed 4:4:4 YUV (Y-U-V ...)
- * @GST_VIDEO_FORMAT_IYU2: packed 4:4:4 YUV (U-Y-V ...) (Since 1.10)
+ * @GST_VIDEO_FORMAT_IYU2: packed 4:4:4 YUV (U-Y-V ...) (Since: 1.10)
  * @GST_VIDEO_FORMAT_RGB16: rgb 5-6-5 bits per component
  * @GST_VIDEO_FORMAT_BGR16: reverse rgb 5-6-5 bits per component
  * @GST_VIDEO_FORMAT_RGB15: rgb 5-5-5 bits per component
@@ -283,7 +283,7 @@ typedef enum
  *   in the least significant bits of the destination.
  * @GST_VIDEO_PACK_FLAG_INTERLACED: The source is interlaced. The unpacked
  *   format will be interlaced as well with each line containing
- *   information from alternating fields. (Since 1.2)
+ *   information from alternating fields. (Since: 1.2)
  *
  * The different flags that can be used when packing and unpacking.
  */
index ce4a4d0..6df8202 100644 (file)
@@ -289,8 +289,8 @@ GstVideoFieldOrder gst_video_field_order_from_string  (const gchar * order);
  * @fps_d: the framerate demnominator
  * @offset: offsets of the planes
  * @stride: strides of the planes
- * @multiview_mode: delivery mode for multiple views. (Since 1.6)
- * @multiview_flags: flags for multiple views configuration (Since 1.6)
+ * @multiview_mode: delivery mode for multiple views. (Since: 1.6)
+ * @multiview_flags: flags for multiple views configuration (Since: 1.6)
  *
  * Information describing image properties. This information can be filled
  * in from GstCaps with gst_video_info_from_caps(). The information is also used
index 34e940b..ffe9dda 100644 (file)
@@ -119,7 +119,7 @@ typedef enum {
  * @GST_VIDEO_RESAMPLER_FLAG_NONE: no flags
  * @GST_VIDEO_RESAMPLER_FLAG_HALF_TAPS: when no taps are given, half the
  *              number of calculated taps. This can be used when making scalers
- *              for the different fields of an interlaced picture. Since 1.10
+ *              for the different fields of an interlaced picture. Since: 1.10
  *
  * Different resampler flags.
  *
index 7cc8b69..f37f172 100644 (file)
@@ -525,7 +525,7 @@ gst_is_video_overlay_prepare_window_handle_message (GstMessage * msg)
  * properties. This helper will install "render-rectangle" property into the
  * class.
  *
- * Since 1.14
+ * Since: 1.14
  */
 void
 gst_video_overlay_install_properties (GObjectClass * oclass, gint last_prop_id)
@@ -553,7 +553,7 @@ gst_video_overlay_install_properties (GObjectClass * oclass, gint last_prop_id)
  *
  * Returns: %TRUE if the @property_id matches the GstVideoOverlay property
  *
- * Since 1.14
+ * Since: 1.14
  */
 gboolean
 gst_video_overlay_set_property (GObject * object, gint last_prop_id,