Fix up and add various "Since" markers and other related docs fixes

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

diff --git a/gst/gstbuffer.c b/gst/gstbuffer.c
index c704bce709d9fd5d976ebf73d38ee80780fada6f..d0b6ee71377f80004444566039aa286b988d91d7 100644 (file)
--- 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 d94b3b4617f6c77117ff1547260b5523218cb224..c9605f1a03bb167c27cb755929ec16a547c4f8df 100644 (file)
--- 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 27784084b30f4c80ba5502723883f7cb5e446784..c8ac3c675f96fddac69fe5bc48b1b74f43fde759 100644 (file)
--- 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 de7781543d2103cf1e891846188dc543eb42d5ce..9012a7d1852a44197c0fbcd67f48f968836cdccf 100644 (file)
--- 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 c850d14a695d7ad640c638900382d4376a62bbaf..ff35507c737d78c28dfa18b844d5c0003adbf34c 100644 (file)
--- 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 5cb2e0888e7f1c4ae7bcf61b3d84d903ee0af7eb..15240ae5dd7421104324a3b100003d2ad42f825e 100644 (file)
--- 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 9c50d3b801ce45cae81fe80f9ad6894e50e081ec..aa989e7b59e6fbc2d5843fde0bca612560a60059 100644 (file)
--- 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 32c4c74e2531aace1321e06dc86e089a46d67c14..3942acebb85964e456a5b8e7c8043fc713a9dd72 100644 (file)
--- 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 a2cc11ef0c59ec7c82973515a703762518850222..5b73a086882b327d2ac23a498e7f8e08459d9e9e 100644 (file)
--- 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 623cd9eb001ea2481d43f556007991e7aab72b48..9747293cb9030f29decaad284b8254c2e7fa5572 100644 (file)
--- 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 185c00c46df312feb6e416c91d2e280668e493e5..16328f6df330797a16fa1fa38c1e23a16e693aa3 100644 (file)
--- 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 b7b16be9201181786e8c7066ceff06eca1249f1d..33c84f25a1e94330255b1ca31f194cdc851dea43 100644 (file)
--- 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 a76a87a196efa93ccd4f922cd37cc7a7b2a960cb..dcbfcebefd1798db5110441fa284c3519ad8bbf4 100644 (file)
--- 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 070c37475c30d56704a2aa5b889469967526fc0f..41638bf180261b4e6f817aa260208f6ecfb2bc36 100644 (file)
--- 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)
 {