mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-11-25 11:11:08 +00:00
doc: Fix and add some missing docstrings
This commit is contained in:
parent
4d259e8af3
commit
5b2da0835e
9 changed files with 69 additions and 1 deletions
|
@ -141,6 +141,13 @@ gst_dynamic_type_factory_create (GstRegistry * registry,
|
||||||
return factory;
|
return factory;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* gst_dynamic_type_register:
|
||||||
|
* @plugin: The #GstPlugin to register @dyn_type for
|
||||||
|
* @type: The #GType to register dynamically
|
||||||
|
*
|
||||||
|
* Registers a new #GstDynamicTypeFactory in the registry
|
||||||
|
*/
|
||||||
gboolean
|
gboolean
|
||||||
gst_dynamic_type_register (GstPlugin * plugin, GType dyn_type)
|
gst_dynamic_type_register (GstPlugin * plugin, GType dyn_type)
|
||||||
{
|
{
|
||||||
|
|
|
@ -3740,6 +3740,13 @@ _priv_gst_element_cleanup (void)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* gst_make_element_message_details:
|
||||||
|
* @name: Name of the first field to set
|
||||||
|
* @...: variable arguments in the same form as #GstStructure
|
||||||
|
*
|
||||||
|
* Create a #GstStructure to be used with #gst_element_message_full_with_details
|
||||||
|
*/
|
||||||
GstStructure *
|
GstStructure *
|
||||||
gst_make_element_message_details (const char *name, ...)
|
gst_make_element_message_details (const char *name, ...)
|
||||||
{
|
{
|
||||||
|
|
|
@ -120,6 +120,11 @@ gboolean gst_element_register (GstPlugin *plug
|
||||||
* matching the specified media types will be selected.
|
* matching the specified media types will be selected.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* GstElementFactoryListType:
|
||||||
|
*
|
||||||
|
* A type defining the type of an element factory.
|
||||||
|
*/
|
||||||
typedef guint64 GstElementFactoryListType;
|
typedef guint64 GstElementFactoryListType;
|
||||||
|
|
||||||
#define GST_ELEMENT_FACTORY_TYPE_DECODER ((GstElementFactoryListType)(G_GUINT64_CONSTANT (1) << 0))
|
#define GST_ELEMENT_FACTORY_TYPE_DECODER ((GstElementFactoryListType)(G_GUINT64_CONSTANT (1) << 0))
|
||||||
|
|
|
@ -41,6 +41,11 @@ typedef struct _GstTracerClass GstTracerClass;
|
||||||
#define GST_TRACER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj),GST_TYPE_TRACER,GstTracerClass))
|
#define GST_TRACER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj),GST_TYPE_TRACER,GstTracerClass))
|
||||||
#define GST_TRACER_CAST(obj) ((GstTracer *)(obj))
|
#define GST_TRACER_CAST(obj) ((GstTracer *)(obj))
|
||||||
|
|
||||||
|
/**
|
||||||
|
* GstTracer:
|
||||||
|
*
|
||||||
|
* The opaque GstTracer instance structure
|
||||||
|
*/
|
||||||
struct _GstTracer {
|
struct _GstTracer {
|
||||||
GstObject parent;
|
GstObject parent;
|
||||||
/*< private >*/
|
/*< private >*/
|
||||||
|
|
|
@ -26,6 +26,11 @@
|
||||||
|
|
||||||
G_BEGIN_DECLS
|
G_BEGIN_DECLS
|
||||||
|
|
||||||
|
/**
|
||||||
|
* GstTracerRecord:
|
||||||
|
*
|
||||||
|
* The opaque GstTracerRecord instance structure
|
||||||
|
*/
|
||||||
typedef struct _GstTracerRecord GstTracerRecord;
|
typedef struct _GstTracerRecord GstTracerRecord;
|
||||||
typedef struct _GstTracerRecordClass GstTracerRecordClass;
|
typedef struct _GstTracerRecordClass GstTracerRecordClass;
|
||||||
|
|
||||||
|
|
|
@ -265,6 +265,12 @@ gst_util_get_object_array (GObject * object, const gchar * name,
|
||||||
* double conversion is not defined/implemented.
|
* double conversion is not defined/implemented.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* gst_util_guint64_to_gdouble:
|
||||||
|
* @value: The #guint64 value to convert to double
|
||||||
|
*
|
||||||
|
* Returns: @value casted to #gdouble
|
||||||
|
*/
|
||||||
gdouble
|
gdouble
|
||||||
gst_util_guint64_to_gdouble (guint64 value)
|
gst_util_guint64_to_gdouble (guint64 value)
|
||||||
{
|
{
|
||||||
|
@ -274,6 +280,12 @@ gst_util_guint64_to_gdouble (guint64 value)
|
||||||
return (gdouble) ((gint64) value);
|
return (gdouble) ((gint64) value);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* gst_util_gdouble_to_guint64:
|
||||||
|
* @value: The #gdouble value to convert guint64 double
|
||||||
|
*
|
||||||
|
* Returns: @value casted to #guint64
|
||||||
|
*/
|
||||||
guint64
|
guint64
|
||||||
gst_util_gdouble_to_guint64 (gdouble value)
|
gst_util_gdouble_to_guint64 (gdouble value)
|
||||||
{
|
{
|
||||||
|
|
|
@ -434,6 +434,12 @@ gst_check_message_error (GstMessage * message, GstMessageType type,
|
||||||
}
|
}
|
||||||
|
|
||||||
/* helper functions */
|
/* helper functions */
|
||||||
|
/**
|
||||||
|
* gst_check_chain_func:
|
||||||
|
*
|
||||||
|
* A fake chain function that appends the buffer to the internal list of
|
||||||
|
* buffers.
|
||||||
|
*/
|
||||||
GstFlowReturn
|
GstFlowReturn
|
||||||
gst_check_chain_func (GstPad * pad, GstObject * parent, GstBuffer * buffer)
|
gst_check_chain_func (GstPad * pad, GstObject * parent, GstBuffer * buffer)
|
||||||
{
|
{
|
||||||
|
@ -1001,6 +1007,15 @@ gst_check_element_push_buffer (const gchar * element_name,
|
||||||
GST_FLOW_OK);
|
GST_FLOW_OK);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* gst_check_abi_list:
|
||||||
|
* @list: A list of GstCheckABIStruct to be verified
|
||||||
|
* @have_abi_sizes: Whether there is a reference ABI size already specified,
|
||||||
|
* if it is %FALSE and the `GST_ABI` environment variable is set, usable code
|
||||||
|
* for @list will be printed.
|
||||||
|
*
|
||||||
|
* Verifies that reference values and current values are equals in @list.
|
||||||
|
*/
|
||||||
void
|
void
|
||||||
gst_check_abi_list (GstCheckABIStruct list[], gboolean have_abi_sizes)
|
gst_check_abi_list (GstCheckABIStruct list[], gboolean have_abi_sizes)
|
||||||
{
|
{
|
||||||
|
|
|
@ -57,6 +57,12 @@ GST_CHECK_API GList * buffers;
|
||||||
GST_CHECK_API GMutex check_mutex;
|
GST_CHECK_API GMutex check_mutex;
|
||||||
GST_CHECK_API GCond check_cond;
|
GST_CHECK_API GCond check_cond;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* GstCheckABIStruct:
|
||||||
|
* @name: The name of the structure
|
||||||
|
* @size: The current size of a structure
|
||||||
|
* @abi_size: The reference size of the structure
|
||||||
|
*/
|
||||||
typedef struct
|
typedef struct
|
||||||
{
|
{
|
||||||
const char *name;
|
const char *name;
|
||||||
|
@ -65,6 +71,12 @@ typedef struct
|
||||||
}
|
}
|
||||||
GstCheckABIStruct;
|
GstCheckABIStruct;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* GstCheckLogFilter:
|
||||||
|
*
|
||||||
|
* Opaque structure containing data about a log filter
|
||||||
|
* function.
|
||||||
|
*/
|
||||||
typedef struct _GstCheckLogFilter GstCheckLogFilter;
|
typedef struct _GstCheckLogFilter GstCheckLogFilter;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
|
@ -383,7 +383,7 @@ gst_queue_class_init (GstQueueClass * klass)
|
||||||
G_PARAM_STATIC_STRINGS));
|
G_PARAM_STATIC_STRINGS));
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* GstQueue:flush-on-eos
|
* queue:flush-on-eos:
|
||||||
*
|
*
|
||||||
* Discard all data in the queue when an EOS event is received, and pass
|
* Discard all data in the queue when an EOS event is received, and pass
|
||||||
* on the EOS event as soon as possible (instead of waiting until all
|
* on the EOS event as soon as possible (instead of waiting until all
|
||||||
|
|
Loading…
Reference in a new issue