mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-12-29 19:50:40 +00:00
Fix up and add various "Since" markers and other related docs fixes
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/536>
This commit is contained in:
parent
fd280c0981
commit
f88b59f49a
14 changed files with 33 additions and 10 deletions
|
@ -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.
|
||||
*
|
||||
|
|
|
@ -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)
|
||||
|
|
|
@ -26,6 +26,8 @@
|
|||
* GstDynamicTypeFactory:
|
||||
*
|
||||
* The opaque #GstDynamicTypeFactory data structure.
|
||||
*
|
||||
* Since: 1.12
|
||||
*/
|
||||
typedef struct _GstDynamicTypeFactory GstDynamicTypeFactory;
|
||||
typedef struct _GstDynamicTypeFactoryClass GstDynamicTypeFactoryClass;
|
||||
|
|
|
@ -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, ...)
|
||||
|
|
|
@ -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 ())
|
||||
|
|
|
@ -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)
|
||||
|
|
|
@ -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,
|
||||
|
|
|
@ -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)
|
||||
|
|
|
@ -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, ...)
|
||||
|
|
|
@ -30,6 +30,8 @@ G_BEGIN_DECLS
|
|||
* GstTracerRecord:
|
||||
*
|
||||
* The opaque GstTracerRecord instance structure
|
||||
*
|
||||
* Since: 1.8
|
||||
*/
|
||||
typedef struct _GstTracerRecord GstTracerRecord;
|
||||
typedef struct _GstTracerRecordClass GstTracerRecordClass;
|
||||
|
|
|
@ -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,
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
{
|
||||
|
|
|
@ -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)
|
||||
{
|
||||
|
|
Loading…
Reference in a new issue