From 18536930ff91ab003b12c9a8abb064f7a7a0cf07 Mon Sep 17 00:00:00 2001 From: Nicolas Dufresne Date: Sat, 13 Jun 2015 09:19:27 -0400 Subject: [PATCH] doc: Don't use deprecated Value: and Type: comment Instead use appropriate annotation. Annotations can be added to the right of the constant name in a comment block. --- gst/gstclock.h | 30 ++++++------------------------ gst/gstelementfactory.h | 30 ++++++------------------------ 2 files changed, 12 insertions(+), 48 deletions(-) diff --git a/gst/gstclock.h b/gst/gstclock.h index 165470e8ca..517444d06d 100644 --- a/gst/gstclock.h +++ b/gst/gstclock.h @@ -63,12 +63,9 @@ typedef gint64 GstClockTimeDiff; typedef gpointer GstClockID; /** - * GST_CLOCK_TIME_NONE: + * GST_CLOCK_TIME_NONE: (value 18446744073709551615) (type GstClockTime) * * Constant to define an undefined clock time. - * - * Value: 18446744073709551615 - * Type: GstClockTime */ #define GST_CLOCK_TIME_NONE ((GstClockTime) -1) /** @@ -80,12 +77,9 @@ typedef gpointer GstClockID; #define GST_CLOCK_TIME_IS_VALID(time) (((GstClockTime)(time)) != GST_CLOCK_TIME_NONE) /** - * GST_CLOCK_STIME_NONE: + * GST_CLOCK_STIME_NONE: (value -9223372036854775808) (type GstClockTimeDiff) * * Constant to define an undefined clock time. - * - * Value: -9223372036854775808 - * Type: #GstClockDiff */ #define GST_CLOCK_STIME_NONE G_MININT64 /** @@ -100,39 +94,27 @@ typedef gpointer GstClockID; /* FIXME: still need to explicitly force types on the defines below */ /** - * GST_SECOND: + * GST_SECOND: (value 1000000000) (type GstClockTime) * * Constant that defines one GStreamer second. - * - * Value: 1000000000 - * Type: GstClockTime */ #define GST_SECOND (G_USEC_PER_SEC * G_GINT64_CONSTANT (1000)) /** - * GST_MSECOND: + * GST_MSECOND: (value 1000000) (type GstClockTime) * * Constant that defines one GStreamer millisecond. - * - * Value: 1000000 - * Type: GstClockTime */ #define GST_MSECOND (GST_SECOND / G_GINT64_CONSTANT (1000)) /** - * GST_USECOND: + * GST_USECOND: (alue: 1000) (type GstClockTime) * * Constant that defines one GStreamer microsecond. - * - * Value: 1000 - * Type: GstClockTime */ #define GST_USECOND (GST_SECOND / G_GINT64_CONSTANT (1000000)) /** - * GST_NSECOND: + * GST_NSECOND: (value 1) (type GstClockTime) * * Constant that defines one GStreamer nanosecond - * - * Value: 1 - * Type: GstClockTime */ #define GST_NSECOND (GST_SECOND / G_GINT64_CONSTANT (1000000000)) diff --git a/gst/gstelementfactory.h b/gst/gstelementfactory.h index 117d00e5b3..f225006c4c 100644 --- a/gst/gstelementfactory.h +++ b/gst/gstelementfactory.h @@ -129,66 +129,48 @@ typedef guint64 GstElementFactoryListType; #define GST_ELEMENT_FACTORY_TYPE_MEDIA_METADATA (G_GUINT64_CONSTANT (1) << 53) /** - * GST_ELEMENT_FACTORY_TYPE_ANY: + * GST_ELEMENT_FACTORY_TYPE_ANY: (value 562949953421311) (type GstElementFactoryListType) * * Elements of any of the defined GST_ELEMENT_FACTORY_LIST types - * - * Value: 562949953421311 - * Type: GstElementFactoryListType */ #define GST_ELEMENT_FACTORY_TYPE_ANY ((G_GUINT64_CONSTANT (1) << 49) - 1) /** - * GST_ELEMENT_FACTORY_TYPE_MEDIA_ANY: + * GST_ELEMENT_FACTORY_TYPE_MEDIA_ANY: (value 18446462598732840960) (type GstElementFactoryListType) * * Elements matching any of the defined GST_ELEMENT_FACTORY_TYPE_MEDIA types * * Note: Do not use this if you wish to not filter against any of the defined * media types. If you wish to do this, simply don't specify any * GST_ELEMENT_FACTORY_TYPE_MEDIA flag. - * - * Value: 18446462598732840960 - * Type: GstElementFactoryListType */ #define GST_ELEMENT_FACTORY_TYPE_MEDIA_ANY (~G_GUINT64_CONSTANT (0) << 48) /** - * GST_ELEMENT_FACTORY_TYPE_VIDEO_ENCODER: + * GST_ELEMENT_FACTORY_TYPE_VIDEO_ENCODER: (value 2814749767106562) (type GstElementFactoryListType) * * All encoders handling video or image media types - * - * Value: 2814749767106562 - * Type: GstElementFactoryListType */ #define GST_ELEMENT_FACTORY_TYPE_VIDEO_ENCODER (GST_ELEMENT_FACTORY_TYPE_ENCODER | GST_ELEMENT_FACTORY_TYPE_MEDIA_VIDEO | GST_ELEMENT_FACTORY_TYPE_MEDIA_IMAGE) /** - * GST_ELEMENT_FACTORY_TYPE_AUDIO_ENCODER: + * GST_ELEMENT_FACTORY_TYPE_AUDIO_ENCODER: (value 1125899906842626) (type GstElementFactoryListType) * * All encoders handling audio media types - * - * Value: 1125899906842626 - * Type: GstElementFactoryListType */ #define GST_ELEMENT_FACTORY_TYPE_AUDIO_ENCODER (GST_ELEMENT_FACTORY_TYPE_ENCODER | GST_ELEMENT_FACTORY_TYPE_MEDIA_AUDIO) /** - * GST_ELEMENT_FACTORY_TYPE_AUDIOVIDEO_SINKS: + * GST_ELEMENT_FACTORY_TYPE_AUDIOVIDEO_SINKS: (value 3940649673949188 (type GstElementFactoryListType) * * All sinks handling audio, video or image media types - * - * Value: 3940649673949188 - * Type: GstElementFactoryListType */ #define GST_ELEMENT_FACTORY_TYPE_AUDIOVIDEO_SINKS (GST_ELEMENT_FACTORY_TYPE_SINK | GST_ELEMENT_FACTORY_TYPE_MEDIA_AUDIO | GST_ELEMENT_FACTORY_TYPE_MEDIA_VIDEO | GST_ELEMENT_FACTORY_TYPE_MEDIA_IMAGE) /** - * GST_ELEMENT_FACTORY_TYPE_DECODABLE: + * GST_ELEMENT_FACTORY_TYPE_DECODABLE: (value 353) (type GstElementFactoryListType) * * All elements used to 'decode' streams (decoders, demuxers, parsers, depayloaders) - * - * Value: 353 - * Type: GstElementFactoryListType */ #define GST_ELEMENT_FACTORY_TYPE_DECODABLE \ (GST_ELEMENT_FACTORY_TYPE_DECODER | GST_ELEMENT_FACTORY_TYPE_DEMUXER | GST_ELEMENT_FACTORY_TYPE_DEPAYLOADER | GST_ELEMENT_FACTORY_TYPE_PARSER | GST_ELEMENT_FACTORY_TYPE_DECRYPTOR)