From f88b59f49a4fe4f2aceb355b3a3a3cde54331bf3 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Sebastian=20Dr=C3=B6ge?= Date: Fri, 19 Jun 2020 12:01:49 +0300 Subject: [PATCH] Fix up and add various "Since" markers and other related docs fixes Part-of: --- gst/gstbuffer.c | 2 +- gst/gstdynamictypefactory.c | 2 ++ gst/gstdynamictypefactory.h | 2 ++ gst/gstelement.c | 2 ++ gst/gstparamspecs.h | 14 ++++++++------ gst/gstparse.c | 2 ++ gst/gststructure.c | 2 ++ gst/gsttracerfactory.c | 2 ++ gst/gsttracerrecord.c | 4 ++++ gst/gsttracerrecord.h | 2 ++ gst/gsttracerutils.c | 2 ++ libs/gst/base/gstadapter.c | 2 +- libs/gst/base/gstaggregator.h | 2 +- libs/gst/base/gstbaseparse.c | 3 ++- 14 files changed, 33 insertions(+), 10 deletions(-) diff --git a/gst/gstbuffer.c b/gst/gstbuffer.c index c704bce709..d0b6ee7137 100644 --- a/gst/gstbuffer.c +++ b/gst/gstbuffer.c @@ -364,7 +364,7 @@ gst_buffer_get_flags (GstBuffer * buffer) } /** - * gst_buffer_flag_is_set: + * gst_buffer_has_flags: * @buffer: a #GstBuffer * @flags: the #GstBufferFlags flag to check. * diff --git a/gst/gstdynamictypefactory.c b/gst/gstdynamictypefactory.c index d94b3b4617..c9605f1a03 100644 --- a/gst/gstdynamictypefactory.c +++ b/gst/gstdynamictypefactory.c @@ -147,6 +147,8 @@ gst_dynamic_type_factory_create (GstRegistry * registry, * @type: The #GType to register dynamically * * Registers a new #GstDynamicTypeFactory in the registry + * + * Since: 1.12 */ gboolean gst_dynamic_type_register (GstPlugin * plugin, GType dyn_type) diff --git a/gst/gstdynamictypefactory.h b/gst/gstdynamictypefactory.h index 27784084b3..c8ac3c675f 100644 --- a/gst/gstdynamictypefactory.h +++ b/gst/gstdynamictypefactory.h @@ -26,6 +26,8 @@ * GstDynamicTypeFactory: * * The opaque #GstDynamicTypeFactory data structure. + * + * Since: 1.12 */ typedef struct _GstDynamicTypeFactory GstDynamicTypeFactory; typedef struct _GstDynamicTypeFactoryClass GstDynamicTypeFactoryClass; diff --git a/gst/gstelement.c b/gst/gstelement.c index de7781543d..9012a7d185 100644 --- a/gst/gstelement.c +++ b/gst/gstelement.c @@ -3835,6 +3835,8 @@ _priv_gst_element_cleanup (void) * @...: variable arguments in the same form as #GstStructure * * Create a #GstStructure to be used with #gst_element_message_full_with_details + * + * Since: 1.10 */ GstStructure * gst_make_element_message_details (const char *name, ...) diff --git a/gst/gstparamspecs.h b/gst/gstparamspecs.h index c850d14a69..ff35507c73 100644 --- a/gst/gstparamspecs.h +++ b/gst/gstparamspecs.h @@ -94,10 +94,10 @@ G_BEGIN_DECLS /* --- type macros --- */ /** - * GstParamArray: + * GstParamFraction: * - * A fundamental type that describes a #GParamSpec for arrays of - * values + * A fundamental type that describes a #GParamSpec for fractional + * properties */ #define GST_TYPE_PARAM_FRACTION (gst_param_spec_fraction_get_type ()) @@ -105,10 +105,12 @@ G_BEGIN_DECLS #define GST_PARAM_SPEC_FRACTION(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), GST_TYPE_PARAM_FRACTION, GstParamSpecFraction)) /** - * GstParamFraction: + * GstParamArray: * - * A fundamental type that describes a #GParamSpec for fractional - * properties + * A fundamental type that describes a #GParamSpec for arrays of + * values + * + * Since: 1.12 */ #define GST_TYPE_PARAM_ARRAY_LIST (gst_param_spec_array_get_type ()) diff --git a/gst/gstparse.c b/gst/gstparse.c index 5cb2e0888e..15240ae5dd 100644 --- a/gst/gstparse.c +++ b/gst/gstparse.c @@ -100,6 +100,8 @@ gst_parse_context_new (void) * Copies the @context. * * Returns: (transfer full) (nullable): A copied #GstParseContext + * + * Since: 1.12.1 */ GstParseContext * gst_parse_context_copy (const GstParseContext * context) diff --git a/gst/gststructure.c b/gst/gststructure.c index 9c50d3b801..aa989e7b59 100644 --- a/gst/gststructure.c +++ b/gst/gststructure.c @@ -3296,6 +3296,8 @@ _gst_structure_get_any_list (GstStructure * structure, GType type, * Returns: %TRUE if the value could be set correctly. If there was no field * with @fieldname or the existing field did not contain a %GST_TYPE_ARRAY, * this function returns %FALSE. + * + * Since: 1.12 */ gboolean gst_structure_get_array (GstStructure * structure, const gchar * fieldname, diff --git a/gst/gsttracerfactory.c b/gst/gsttracerfactory.c index 32c4c74e25..3942acebb8 100644 --- a/gst/gsttracerfactory.c +++ b/gst/gsttracerfactory.c @@ -88,6 +88,8 @@ gst_tracer_factory_get_list (void) * * Returns: the #GType for tracers managed by this factory or 0 if * the factory is not loaded. + * + * Since: 1.14 */ GType gst_tracer_factory_get_tracer_type (GstTracerFactory * factory) diff --git a/gst/gsttracerrecord.c b/gst/gsttracerrecord.c index a2cc11ef0c..5b73a08688 100644 --- a/gst/gsttracerrecord.c +++ b/gst/gsttracerrecord.c @@ -179,6 +179,8 @@ gst_tracer_record_init (GstTracerRecord * self) * > Please note that this is still under discussion and subject to change. * * Returns: (transfer full): a new #GstTracerRecord + * + * Since: 1.8 */ GstTracerRecord * gst_tracer_record_new (const gchar * name, const gchar * firstfield, ...) @@ -247,6 +249,8 @@ gst_tracer_record_new (const gchar * name, const gchar * firstfield, ...) * the category "GST_TRACER". * * > Please note that this is still under discussion and subject to change. + * + * Since: 1.8 */ void gst_tracer_record_log (GstTracerRecord * self, ...) diff --git a/gst/gsttracerrecord.h b/gst/gsttracerrecord.h index 623cd9eb00..9747293cb9 100644 --- a/gst/gsttracerrecord.h +++ b/gst/gsttracerrecord.h @@ -30,6 +30,8 @@ G_BEGIN_DECLS * GstTracerRecord: * * The opaque GstTracerRecord instance structure + * + * Since: 1.8 */ typedef struct _GstTracerRecord GstTracerRecord; typedef struct _GstTracerRecordClass GstTracerRecordClass; diff --git a/gst/gsttracerutils.c b/gst/gsttracerutils.c index 185c00c46d..16328f6df3 100644 --- a/gst/gsttracerutils.c +++ b/gst/gsttracerutils.c @@ -188,6 +188,8 @@ gst_tracing_register_hook_id (GstTracer * tracer, GQuark detail, GCallback func) * * Register @func to be called when the trace hook @detail is getting invoked. * Use %NULL for @detail to register to all hooks. + * + * Since: 1.8 */ void gst_tracing_register_hook (GstTracer * tracer, const gchar * detail, diff --git a/libs/gst/base/gstadapter.c b/libs/gst/base/gstadapter.c index b7b16be920..33c84f25a1 100644 --- a/libs/gst/base/gstadapter.c +++ b/libs/gst/base/gstadapter.c @@ -1365,7 +1365,7 @@ gst_adapter_available_fast (GstAdapter * adapter) } /** - * gst_adapter_get_distance_from_discont: + * gst_adapter_distance_from_discont: * @adapter: a #GstAdapter * * Get the distance in bytes since the last buffer with the diff --git a/libs/gst/base/gstaggregator.h b/libs/gst/base/gstaggregator.h index a76a87a196..dcbfcebefd 100644 --- a/libs/gst/base/gstaggregator.h +++ b/libs/gst/base/gstaggregator.h @@ -397,7 +397,7 @@ void gst_aggregator_update_segment (GstAggregator * @GST_AGGREGATOR_START_TIME_SELECTION_SET: Start at the running time * selected by the `start-time` property. * - * Since: 1.14 + * Since: 1.18 */ typedef enum { diff --git a/libs/gst/base/gstbaseparse.c b/libs/gst/base/gstbaseparse.c index 070c37475c..41638bf180 100644 --- a/libs/gst/base/gstbaseparse.c +++ b/libs/gst/base/gstbaseparse.c @@ -684,8 +684,9 @@ gst_base_parse_get_property (GObject * object, guint prop_id, GValue * value, * Copies a #GstBaseParseFrame. * * Returns: A copy of @frame + * + * Since: 1.12.1 */ - GstBaseParseFrame * gst_base_parse_frame_copy (GstBaseParseFrame * frame) { -- 2.34.1