projects / platform / upstream / gstreamer.git / commitdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: f0a1584)
docs: link to concrete types rather than type macros
authorMathieu Duponchelle <mathieu@centricular.com>
Fri, 24 Sep 2021 23:53:35 +0000 (01:53 +0200)
committerGStreamer Marge Bot <gitlab-merge-bot@gstreamer-foundation.org>
Sat, 25 Sep 2021 01:29:38 +0000 (01:29 +0000)
Latest hotdoc version extended the ignored, boilerplate macros
to now include TYPE macros for records as well

Linking to the concrete type is more informative

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/913>

subprojects/gstreamer/gst/gstbin.c patch | blob | history
subprojects/gstreamer/gst/gstvalue.h patch | blob | history

diff --git a/subprojects/gstreamer/gst/gstbin.c b/subprojects/gstreamer/gst/gstbin.c
index 5a536c7..571d7cd 100644 (file)
--- a/subprojects/gstreamer/gst/gstbin.c
+++ b/subprojects/gstreamer/gst/gstbin.c
@@ -438,8 +438,7 @@ gst_bin_class_init (GstBinClass * klass)
    *
    * The messages are converted to an ELEMENT message with the bin as the
    * source. The structure of the message is named `GstBinForwarded` and contains
    *
    * The messages are converted to an ELEMENT message with the bin as the
    * source. The structure of the message is named `GstBinForwarded` and contains
-   * a field named `message` of type %GST_TYPE_MESSAGE that contains the original
-   * forwarded message.
+   * a field named `message` that contains the original forwarded #GstMessage.
    */
   g_object_class_install_property (gobject_class, PROP_MESSAGE_FORWARD,
       g_param_spec_boolean ("message-forward", "Message Forward",
    */
   g_object_class_install_property (gobject_class, PROP_MESSAGE_FORWARD,
       g_param_spec_boolean ("message-forward", "Message Forward",
diff --git a/subprojects/gstreamer/gst/gstvalue.h b/subprojects/gstreamer/gst/gstvalue.h
index 4c5bf29..1802904 100644 (file)
--- a/subprojects/gstreamer/gst/gstvalue.h
+++ b/subprojects/gstreamer/gst/gstvalue.h
@@ -93,7 +93,7 @@ G_BEGIN_DECLS
  * GST_VALUE_HOLDS_INT_RANGE:
  * @x: the #GValue to check
  *
  * GST_VALUE_HOLDS_INT_RANGE:
  * @x: the #GValue to check
  *
- * Checks if the given #GValue contains a #GST_TYPE_INT_RANGE value.
+ * Checks if the given #GValue contains a #GstIntRange value.
  */
 #define GST_VALUE_HOLDS_INT_RANGE(x)      ((gpointer)(x) != NULL && G_VALUE_TYPE(x) == _gst_int_range_type)
 
  */
 #define GST_VALUE_HOLDS_INT_RANGE(x)      ((gpointer)(x) != NULL && G_VALUE_TYPE(x) == _gst_int_range_type)
 
@@ -101,7 +101,7 @@ G_BEGIN_DECLS
  * GST_VALUE_HOLDS_INT64_RANGE:
  * @x: the #GValue to check
  *
  * GST_VALUE_HOLDS_INT64_RANGE:
  * @x: the #GValue to check
  *
- * Checks if the given #GValue contains a #GST_TYPE_INT64_RANGE value.
+ * Checks if the given #GValue contains a #GstInt64Range value.
  */
 #define GST_VALUE_HOLDS_INT64_RANGE(x)    ((gpointer)(x) != NULL && G_VALUE_TYPE(x) == _gst_int64_range_type)
 
  */
 #define GST_VALUE_HOLDS_INT64_RANGE(x)    ((gpointer)(x) != NULL && G_VALUE_TYPE(x) == _gst_int64_range_type)
 
@@ -109,7 +109,7 @@ G_BEGIN_DECLS
  * GST_VALUE_HOLDS_DOUBLE_RANGE:
  * @x: the #GValue to check
  *
  * GST_VALUE_HOLDS_DOUBLE_RANGE:
  * @x: the #GValue to check
  *
- * Checks if the given #GValue contains a #GST_TYPE_DOUBLE_RANGE value.
+ * Checks if the given #GValue contains a #GstDoubleRange value.
  */
 #define GST_VALUE_HOLDS_DOUBLE_RANGE(x)   ((gpointer)(x) != NULL && G_VALUE_TYPE(x) == _gst_double_range_type)
 
  */
 #define GST_VALUE_HOLDS_DOUBLE_RANGE(x)   ((gpointer)(x) != NULL && G_VALUE_TYPE(x) == _gst_double_range_type)
 
@@ -117,7 +117,7 @@ G_BEGIN_DECLS
  * GST_VALUE_HOLDS_FRACTION_RANGE:
  * @x: the #GValue to check
  *
  * GST_VALUE_HOLDS_FRACTION_RANGE:
  * @x: the #GValue to check
  *
- * Checks if the given #GValue contains a #GST_TYPE_FRACTION_RANGE value.
+ * Checks if the given #GValue contains a #GstFractionRange value.
  */
 #define GST_VALUE_HOLDS_FRACTION_RANGE(x) ((gpointer)(x) != NULL && G_VALUE_TYPE(x) == _gst_fraction_range_type)
 
  */
 #define GST_VALUE_HOLDS_FRACTION_RANGE(x) ((gpointer)(x) != NULL && G_VALUE_TYPE(x) == _gst_fraction_range_type)
 
@@ -125,7 +125,7 @@ G_BEGIN_DECLS
  * GST_VALUE_HOLDS_LIST:
  * @x: the #GValue to check
  *
  * GST_VALUE_HOLDS_LIST:
  * @x: the #GValue to check
  *
- * Checks if the given #GValue contains a #GST_TYPE_LIST value.
+ * Checks if the given #GValue contains a #GstValueList value.
  */
 #define GST_VALUE_HOLDS_LIST(x)         ((gpointer)(x) != NULL && G_VALUE_TYPE(x) == _gst_value_list_type)
 
  */
 #define GST_VALUE_HOLDS_LIST(x)         ((gpointer)(x) != NULL && G_VALUE_TYPE(x) == _gst_value_list_type)
 
@@ -133,7 +133,7 @@ G_BEGIN_DECLS
  * GST_VALUE_HOLDS_ARRAY:
  * @x: the #GValue to check
  *
  * GST_VALUE_HOLDS_ARRAY:
  * @x: the #GValue to check
  *
- * Checks if the given #GValue contains a #GST_TYPE_ARRAY value.
+ * Checks if the given #GValue contains a #GstValueArray value.
  */
 #define GST_VALUE_HOLDS_ARRAY(x)        ((gpointer)(x) != NULL && G_VALUE_TYPE(x) == _gst_value_array_type)
 
  */
 #define GST_VALUE_HOLDS_ARRAY(x)        ((gpointer)(x) != NULL && G_VALUE_TYPE(x) == _gst_value_array_type)
 
@@ -141,7 +141,7 @@ G_BEGIN_DECLS
  * GST_VALUE_HOLDS_CAPS:
  * @x: the #GValue to check
  *
  * GST_VALUE_HOLDS_CAPS:
  * @x: the #GValue to check
  *
- * Checks if the given #GValue contains a #GST_TYPE_CAPS value.
+ * Checks if the given #GValue contains a #GstCaps value.
  */
 #define GST_VALUE_HOLDS_CAPS(x)         ((gpointer)(x) != NULL && G_VALUE_TYPE(x) == _gst_caps_type)
 
  */
 #define GST_VALUE_HOLDS_CAPS(x)         ((gpointer)(x) != NULL && G_VALUE_TYPE(x) == _gst_caps_type)
 
@@ -149,7 +149,7 @@ G_BEGIN_DECLS
  * GST_VALUE_HOLDS_STRUCTURE:
  * @x: the #GValue to check
  *
  * GST_VALUE_HOLDS_STRUCTURE:
  * @x: the #GValue to check
  *
- * Checks if the given #GValue contains a #GST_TYPE_STRUCTURE value.
+ * Checks if the given #GValue contains a #GstStructure value.
  */
 #define GST_VALUE_HOLDS_STRUCTURE(x)      ((gpointer)(x) != NULL && G_VALUE_TYPE(x) == _gst_structure_type)
 
  */
 #define GST_VALUE_HOLDS_STRUCTURE(x)      ((gpointer)(x) != NULL && G_VALUE_TYPE(x) == _gst_structure_type)
 
@@ -157,7 +157,7 @@ G_BEGIN_DECLS
  * GST_VALUE_HOLDS_CAPS_FEATURES:
  * @x: the #GValue to check
  *
  * GST_VALUE_HOLDS_CAPS_FEATURES:
  * @x: the #GValue to check
  *
- * Checks if the given #GValue contains a #GST_TYPE_CAPS_FEATURES value.
+ * Checks if the given #GValue contains a #GstCapsFeatures value.
  */
 #define GST_VALUE_HOLDS_CAPS_FEATURES(x)  ((gpointer)(x) != NULL && G_VALUE_TYPE(x) == _gst_caps_features_type)
 
  */
 #define GST_VALUE_HOLDS_CAPS_FEATURES(x)  ((gpointer)(x) != NULL && G_VALUE_TYPE(x) == _gst_caps_features_type)
 
@@ -165,7 +165,7 @@ G_BEGIN_DECLS
  * GST_VALUE_HOLDS_BUFFER:
  * @x: the #GValue to check
  *
  * GST_VALUE_HOLDS_BUFFER:
  * @x: the #GValue to check
  *
- * Checks if the given #GValue contains a #GST_TYPE_BUFFER value.
+ * Checks if the given #GValue contains a #GstBuffer value.
  */
 #define GST_VALUE_HOLDS_BUFFER(x)       ((gpointer)(x) != NULL && G_VALUE_TYPE(x) == _gst_buffer_type)
 
  */
 #define GST_VALUE_HOLDS_BUFFER(x)       ((gpointer)(x) != NULL && G_VALUE_TYPE(x) == _gst_buffer_type)
 
@@ -173,7 +173,7 @@ G_BEGIN_DECLS
  * GST_VALUE_HOLDS_SAMPLE:
  * @x: the #GValue to check
  *
  * GST_VALUE_HOLDS_SAMPLE:
  * @x: the #GValue to check
  *
- * Checks if the given #GValue contains a #GST_TYPE_SAMPLE value.
+ * Checks if the given #GValue contains a #GstSample value.
  */
 #define GST_VALUE_HOLDS_SAMPLE(x)       ((gpointer)(x) != NULL && G_VALUE_TYPE(x) == _gst_sample_type)
 
  */
 #define GST_VALUE_HOLDS_SAMPLE(x)       ((gpointer)(x) != NULL && G_VALUE_TYPE(x) == _gst_sample_type)
 
@@ -181,7 +181,7 @@ G_BEGIN_DECLS
  * GST_VALUE_HOLDS_FRACTION:
  * @x: the #GValue to check
  *
  * GST_VALUE_HOLDS_FRACTION:
  * @x: the #GValue to check
  *
- * Checks if the given #GValue contains a #GST_TYPE_FRACTION value.
+ * Checks if the given #GValue contains a #GstFraction value.
  */
 #define GST_VALUE_HOLDS_FRACTION(x)     ((gpointer)(x) != NULL && G_VALUE_TYPE(x) == _gst_fraction_type)
 
  */
 #define GST_VALUE_HOLDS_FRACTION(x)     ((gpointer)(x) != NULL && G_VALUE_TYPE(x) == _gst_fraction_type)
 
@@ -189,7 +189,7 @@ G_BEGIN_DECLS
  * GST_VALUE_HOLDS_DATE_TIME:
  * @x: the #GValue to check
  *
  * GST_VALUE_HOLDS_DATE_TIME:
  * @x: the #GValue to check
  *
- * Checks if the given #GValue contains a #GST_TYPE_DATE_TIME value.
+ * Checks if the given #GValue contains a #GstDateTime value.
  */
 #define GST_VALUE_HOLDS_DATE_TIME(x)    ((gpointer)(x) != NULL && G_VALUE_TYPE(x) == _gst_date_time_type)
 
  */
 #define GST_VALUE_HOLDS_DATE_TIME(x)    ((gpointer)(x) != NULL && G_VALUE_TYPE(x) == _gst_date_time_type)
 
@@ -197,7 +197,7 @@ G_BEGIN_DECLS
  * GST_VALUE_HOLDS_BITMASK:
  * @x: the #GValue to check
  *
  * GST_VALUE_HOLDS_BITMASK:
  * @x: the #GValue to check
  *
- * Checks if the given #GValue contains a #GST_TYPE_BITMASK value.
+ * Checks if the given #GValue contains a #GstBitmask value.
  */
 #define GST_VALUE_HOLDS_BITMASK(x)      ((gpointer)(x) != NULL && G_VALUE_TYPE(x) == _gst_bitmask_type)
 
  */
 #define GST_VALUE_HOLDS_BITMASK(x)      ((gpointer)(x) != NULL && G_VALUE_TYPE(x) == _gst_bitmask_type)
 
@@ -205,7 +205,7 @@ G_BEGIN_DECLS
  * GST_VALUE_HOLDS_FLAG_SET:
  * @x: the #GValue to check
  *
  * GST_VALUE_HOLDS_FLAG_SET:
  * @x: the #GValue to check
  *
- * Checks if the given #GValue contains a #GST_TYPE_FLAG_SET value.
+ * Checks if the given #GValue contains a #GstFlagSet value.
  *
  * Since: 1.6
  */
  *
  * Since: 1.6
  */
Domain: Multimedia / Media Common;