docs: fix wrong use of Since: keyword
authorStefan Kost <ensonic@users.sf.net>
Wed, 8 Dec 2010 10:09:45 +0000 (12:09 +0200)
committerStefan Kost <ensonic@users.sf.net>
Wed, 8 Dec 2010 10:11:23 +0000 (12:11 +0200)
gst-libs/gst/pbutils/gstdiscoverer-types.c
gst-libs/gst/pbutils/gstdiscoverer.c
gst-libs/gst/rtp/gstrtpbuffer.c

index a3d6bf0..c027ba4 100644 (file)
@@ -385,7 +385,7 @@ gst_discoverer_stream_info_list_free (GList * infos)
  * Returns: A #GList of matching #GstDiscovererStreamInfo. The caller should
  * free it with #gst_discoverer_stream_info_list_free.
  *
- * Since 0.10.31
+ * Since: 0.10.31
  */
 GList *
 gst_discoverer_info_get_streams (GstDiscovererInfo * info, GType streamtype)
@@ -411,7 +411,7 @@ gst_discoverer_info_get_streams (GstDiscovererInfo * info, GType streamtype)
  * Returns: A #GList of matching #GstDiscovererStreamInfo. The caller should
  * free it with #gst_discoverer_stream_info_list_free.
  *
- * Since 0.10.31
+ * Since: 0.10.31
  */
 GList *
 gst_discoverer_info_get_audio_streams (GstDiscovererInfo * info)
@@ -428,7 +428,7 @@ gst_discoverer_info_get_audio_streams (GstDiscovererInfo * info)
  * Returns: A #GList of matching #GstDiscovererStreamInfo. The caller should
  * free it with #gst_discoverer_stream_info_list_free.
  *
- * Since 0.10.31
+ * Since: 0.10.31
  */
 GList *
 gst_discoverer_info_get_video_streams (GstDiscovererInfo * info)
@@ -445,7 +445,7 @@ gst_discoverer_info_get_video_streams (GstDiscovererInfo * info)
  * Returns: A #GList of matching #GstDiscovererStreamInfo. The caller should
  * free it with #gst_discoverer_stream_info_list_free.
  *
- * Since 0.10.31
+ * Since: 0.10.31
  */
 GList *
 gst_discoverer_info_get_container_streams (GstDiscovererInfo * info)
@@ -461,7 +461,7 @@ gst_discoverer_info_get_container_streams (GstDiscovererInfo * info)
  * Returns: a human readable name for the stream type of the given @info (ex : "audio",
  * "container",...).
  *
- * Since 0.10.31
+ * Since: 0.10.31
  */
 const gchar *
 gst_discoverer_stream_info_get_stream_type_nick (GstDiscovererStreamInfo * info)
@@ -496,7 +496,7 @@ gst_discoverer_stream_info_get_stream_type_nick (GstDiscovererStreamInfo * info)
  * Returns: the previous #GstDiscovererStreamInfo in a chain. %NULL for starting
  * points. Unref with #gst_discoverer_stream_info_unref after usage.
  *
- * Since 0.10.31
+ * Since: 0.10.31
  */
 GstDiscovererStreamInfo *
 gst_discoverer_stream_info_get_previous (GstDiscovererStreamInfo * info)
@@ -515,7 +515,7 @@ gst_discoverer_stream_info_get_previous (GstDiscovererStreamInfo * info)
  * Returns: the next #GstDiscovererStreamInfo in a chain. %NULL for final streams.
  * Unref with #gst_discoverer_stream_info_unref after usage.
  *
- * Since 0.10.31
+ * Since: 0.10.31
  */
 GstDiscovererStreamInfo *
 gst_discoverer_stream_info_get_next (GstDiscovererStreamInfo * info)
@@ -534,7 +534,7 @@ gst_discoverer_stream_info_get_next (GstDiscovererStreamInfo * info)
  *
  * Returns: the #GstCaps of the stream. Unref with #gst_caps_unref after usage.
  *
- * Since 0.10.31
+ * Since: 0.10.31
  */
 GstCaps *
 gst_discoverer_stream_info_get_caps (GstDiscovererStreamInfo * info)
@@ -553,7 +553,7 @@ gst_discoverer_stream_info_get_caps (GstDiscovererStreamInfo * info)
  * Returns: the tags contained in this stream. If you wish to use the tags after
  * the life-time of @info you will need to copy them.
  *
- * Since 0.10.31
+ * Since: 0.10.31
  */
 
 const GstTagList *
@@ -572,7 +572,7 @@ gst_discoverer_stream_info_get_tags (GstDiscovererStreamInfo * info)
  * profile, etc..). If you wish to use the #GstStructure after the life-time of
  * @info you will need to copy it.
  *
- * Since 0.10.31
+ * Since: 0.10.31
  */
 const GstStructure *
 gst_discoverer_stream_info_get_misc (GstDiscovererStreamInfo * info)
@@ -591,7 +591,7 @@ gst_discoverer_stream_info_get_misc (GstDiscovererStreamInfo * info)
  * Returns: the list of #GstDiscovererStreamInfo this container stream offers.
  * Free with #gst_discoverer_stream_info_list_free after usage.
  *
- * Since 0.10.31
+ * Since: 0.10.31
  */
 
 GList *
@@ -622,7 +622,7 @@ gst_discoverer_container_info_get_streams (GstDiscovererContainerInfo * info)
  *
  * Returns: the number of channels in the stream.
  *
- * Since 0.10.31
+ * Since: 0.10.31
  */
 
 AUDIO_INFO_ACCESSOR_CODE (channels, guint, 0);
@@ -633,7 +633,7 @@ AUDIO_INFO_ACCESSOR_CODE (channels, guint, 0);
  *
  * Returns: the sample rate of the stream in Hertz.
  *
- * Since 0.10.31
+ * Since: 0.10.31
  */
 
 AUDIO_INFO_ACCESSOR_CODE (sample_rate, guint, 0);
@@ -644,7 +644,7 @@ AUDIO_INFO_ACCESSOR_CODE (sample_rate, guint, 0);
  *
  * Returns: the number of bits used per sample in each channel.
  *
- * Since 0.10.31
+ * Since: 0.10.31
  */
 
 AUDIO_INFO_ACCESSOR_CODE (depth, guint, 0);
@@ -655,7 +655,7 @@ AUDIO_INFO_ACCESSOR_CODE (depth, guint, 0);
  *
  * Returns: the average or nominal bitrate of the stream in bits/second.
  *
- * Since 0.10.31
+ * Since: 0.10.31
  */
 
 AUDIO_INFO_ACCESSOR_CODE (bitrate, guint, 0);
@@ -666,7 +666,7 @@ AUDIO_INFO_ACCESSOR_CODE (bitrate, guint, 0);
  *
  * Returns: the maximum bitrate of the stream in bits/second.
  *
- * Since 0.10.31
+ * Since: 0.10.31
  */
 
 AUDIO_INFO_ACCESSOR_CODE (max_bitrate, guint, 0);
@@ -684,7 +684,7 @@ AUDIO_INFO_ACCESSOR_CODE (max_bitrate, guint, 0);
  *
  * Returns: the width of the video stream in pixels.
  *
- * Since 0.10.31
+ * Since: 0.10.31
  */
 
 VIDEO_INFO_ACCESSOR_CODE (width, guint, 0);
@@ -695,7 +695,7 @@ VIDEO_INFO_ACCESSOR_CODE (width, guint, 0);
  *
  * Returns: the height of the video stream in pixels.
  *
- * Since 0.10.31
+ * Since: 0.10.31
  */
 
 VIDEO_INFO_ACCESSOR_CODE (height, guint, 0);
@@ -707,7 +707,7 @@ VIDEO_INFO_ACCESSOR_CODE (height, guint, 0);
  * Returns: the depth in bits of the video stream (only relevant for
  * video streams).
  *
- * Since 0.10.31
+ * Since: 0.10.31
  */
 
 VIDEO_INFO_ACCESSOR_CODE (depth, guint, 0);
@@ -718,7 +718,7 @@ VIDEO_INFO_ACCESSOR_CODE (depth, guint, 0);
  *
  * Returns: the framerate of the video stream (numerator).
  *
- * Since 0.10.31
+ * Since: 0.10.31
  */
 
 VIDEO_INFO_ACCESSOR_CODE (framerate_num, guint, 0);
@@ -729,7 +729,7 @@ VIDEO_INFO_ACCESSOR_CODE (framerate_num, guint, 0);
  *
  * Returns: the framerate of the video stream (denominator).
  *
- * Since 0.10.31
+ * Since: 0.10.31
  */
 
 VIDEO_INFO_ACCESSOR_CODE (framerate_denom, guint, 0);
@@ -740,7 +740,7 @@ VIDEO_INFO_ACCESSOR_CODE (framerate_denom, guint, 0);
  *
  * Returns: the Pixel Aspect Ratio (PAR) of the video stream (numerator).
  *
- * Since 0.10.31
+ * Since: 0.10.31
  */
 
 VIDEO_INFO_ACCESSOR_CODE (par_num, guint, 0);
@@ -751,7 +751,7 @@ VIDEO_INFO_ACCESSOR_CODE (par_num, guint, 0);
  *
  * Returns: the Pixel Aspect Ratio (PAR) of the video stream (denominator).
  *
- * Since 0.10.31
+ * Since: 0.10.31
  */
 
 VIDEO_INFO_ACCESSOR_CODE (par_denom, guint, 0);
@@ -762,7 +762,7 @@ VIDEO_INFO_ACCESSOR_CODE (par_denom, guint, 0);
  *
  * Returns: %TRUE if the stream is interlaced, else %FALSE.
  *
- * Since 0.10.31
+ * Since: 0.10.31
  */
 gboolean
 gst_discoverer_video_info_is_interlaced (const GstDiscovererVideoInfo * info)
@@ -778,7 +778,7 @@ gst_discoverer_video_info_is_interlaced (const GstDiscovererVideoInfo * info)
  *
  * Returns: the average or nominal bitrate of the video stream in bits/second.
  *
- * Since 0.10.31
+ * Since: 0.10.31
  */
 
 VIDEO_INFO_ACCESSOR_CODE (bitrate, guint, 0);
@@ -789,7 +789,7 @@ VIDEO_INFO_ACCESSOR_CODE (bitrate, guint, 0);
  *
  * Returns: the maximum bitrate of the video stream in bits/second.
  *
- * Since 0.10.31
+ * Since: 0.10.31
  */
 
 VIDEO_INFO_ACCESSOR_CODE (max_bitrate, guint, 0);
@@ -801,7 +801,7 @@ VIDEO_INFO_ACCESSOR_CODE (max_bitrate, guint, 0);
  * Returns: #TRUE if the video stream corresponds to an image (i.e. only contains
  * one frame).
  *
- * Since 0.10.31
+ * Since: 0.10.31
  */
 gboolean
 gst_discoverer_video_info_is_image (const GstDiscovererVideoInfo * info)
@@ -825,7 +825,7 @@ gst_discoverer_video_info_is_image (const GstDiscovererVideoInfo * info)
  * Returns: the URI to which this information corresponds to. Copy it if you
  * wish to use it after the life-time of @info.
  *
- * Since 0.10.31
+ * Since: 0.10.31
  */
 
 DISCOVERER_INFO_ACCESSOR_CODE (uri, const gchar *, NULL);
@@ -836,7 +836,7 @@ DISCOVERER_INFO_ACCESSOR_CODE (uri, const gchar *, NULL);
  *
  * Returns: the result of the discovery as a #GstDiscovererResult.
  *
- * Since 0.10.31
+ * Since: 0.10.31
  */
 
 DISCOVERER_INFO_ACCESSOR_CODE (result, GstDiscovererResult, GST_DISCOVERER_OK);
@@ -849,7 +849,7 @@ DISCOVERER_INFO_ACCESSOR_CODE (result, GstDiscovererResult, GST_DISCOVERER_OK);
  * This structure can be traversed to see the original hierarchy. Unref with
  * #gst_discoverer_stream_info_unref after usage.
  *
- * Since 0.10.31
+ * Since: 0.10.31
  */
 
 GstDiscovererStreamInfo *
@@ -869,7 +869,7 @@ gst_discoverer_info_get_stream_info (GstDiscovererInfo * info)
  * Returns: the list of all streams contained in the #info. Free after usage
  * with #gst_discoverer_stream_info_list_free.
  *
- * Since 0.10.31
+ * Since: 0.10.31
  */
 GList *
 gst_discoverer_info_get_stream_list (GstDiscovererInfo * info)
@@ -892,7 +892,7 @@ gst_discoverer_info_get_stream_list (GstDiscovererInfo * info)
  *
  * Returns: the duration of the URI in #GstClockTime (nanoseconds).
  *
- * Since 0.10.31
+ * Since: 0.10.31
  */
 
 DISCOVERER_INFO_ACCESSOR_CODE (duration, GstClockTime, GST_CLOCK_TIME_NONE);
@@ -905,7 +905,7 @@ DISCOVERER_INFO_ACCESSOR_CODE (duration, GstClockTime, GST_CLOCK_TIME_NONE);
  * information about missing plugins). If you wish to use the #GstStructure
  * after the life-time of @info, you will need to copy it.
  *
- * Since 0.10.31
+ * Since: 0.10.31
  */
 
 DISCOVERER_INFO_ACCESSOR_CODE (misc, const GstStructure *, NULL);
@@ -917,7 +917,7 @@ DISCOVERER_INFO_ACCESSOR_CODE (misc, const GstStructure *, NULL);
  * Returns: all tags contained in the %URI. If you wish to use the tags after
  * the life-time of @info, you will need to copy them.
  *
- * Since 0.10.31
+ * Since: 0.10.31
  */
 
 DISCOVERER_INFO_ACCESSOR_CODE (tags, const GstTagList *, NULL);
index 61208ac..6a3aadc 100644 (file)
@@ -37,7 +37,7 @@
  *
  * All the information is returned in a #GstDiscovererInfo structure.
  * 
- * Since 0.10.31
+ * Since: 0.10.31
  */
 
 #ifdef HAVE_CONFIG_H
@@ -1222,7 +1222,7 @@ gst_discoverer_start (GstDiscoverer * discoverer)
  * Stop the discovery of any pending URIs and clears the list of
  * pending URIS (if any).
  * 
- * Since 0.10.31
+ * Since: 0.10.31
  */
 void
 gst_discoverer_stop (GstDiscoverer * discoverer)
index 68fc67a..1cf608b 100644 (file)
@@ -739,7 +739,7 @@ gst_rtp_buffer_get_extension_data (GstBuffer * buffer, guint16 * bits,
  *
  * Returns: True if done.
  *
- * Since : 0.10.18
+ * Since: 0.10.18
  */
 gboolean
 gst_rtp_buffer_set_extension_data (GstBuffer * buffer, guint16 bits,