doc: document fundamental types

This commit is contained in:
Mathieu Duponchelle 2020-06-04 03:24:50 +02:00 committed by Thibault Saunier
parent 31e68eb26a
commit cc87357105
2 changed files with 69 additions and 0 deletions

View file

@ -79,10 +79,23 @@ G_BEGIN_DECLS
/* --- type macros --- */
/**
* GstParamArray:
*
* A fundamental type that describes a #GParamSpec for arrays of
* values
*/
#define GST_TYPE_PARAM_FRACTION (gst_param_spec_fraction_get_type ())
#define GST_IS_PARAM_SPEC_FRACTION(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), GST_TYPE_PARAM_FRACTION))
#define GST_PARAM_SPEC_FRACTION(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), GST_TYPE_PARAM_FRACTION, GstParamSpecFraction))
/**
* GstParamFraction:
*
* A fundamental type that describes a #GParamSpec for fractional
* properties
*/
#define GST_TYPE_PARAM_ARRAY_LIST (gst_param_spec_array_get_type ())
#define GST_IS_PARAM_SPEC_ARRAY_LIST(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), GST_TYPE_PARAM_ARRAY_LIST))

View file

@ -224,6 +224,12 @@ G_BEGIN_DECLS
GST_API GType _gst_int_range_type;
/**
* GstIntRange:
*
* A fundamental type that describes a #gint range
*/
/**
* GST_TYPE_INT_RANGE:
*
@ -235,6 +241,12 @@ GST_API GType _gst_int_range_type;
GST_API GType _gst_int64_range_type;
/**
* GstInt64Range:
*
* A fundamental type that describes a #gint64 range
*/
/**
* GST_TYPE_INT64_RANGE:
*
@ -246,6 +258,12 @@ GST_API GType _gst_int64_range_type;
GST_API GType _gst_double_range_type;
/**
* GstDoubleRange:
*
* A fundamental type that describes a #gdouble range
*/
/**
* GST_TYPE_DOUBLE_RANGE:
*
@ -257,6 +275,12 @@ GST_API GType _gst_double_range_type;
GST_API GType _gst_fraction_range_type;
/**
* GstFractionRange:
*
* A fundamental type that describes a #GstFractionRange range
*/
/**
* GST_TYPE_FRACTION_RANGE:
*
@ -268,6 +292,12 @@ GST_API GType _gst_fraction_range_type;
GST_API GType _gst_value_list_type;
/**
* GstValueList:
*
* A fundamental type that describes an unordered list of #GValue
*/
/**
* GST_TYPE_LIST:
*
@ -283,6 +313,12 @@ GST_API GType _gst_value_list_type;
GST_API GType _gst_value_array_type;
/**
* GstValueArray:
*
* A fundamental type that describes an ordered list of #GValue
*/
/**
* GST_TYPE_ARRAY:
*
@ -299,6 +335,13 @@ GST_API GType _gst_value_array_type;
GST_API GType _gst_fraction_type;
/**
* GstFraction:
*
* A fundamental type that describes a fraction of an integer numerator
* over an integer denominator
*/
/**
* GST_TYPE_FRACTION:
*
@ -312,6 +355,12 @@ GST_API GType _gst_fraction_type;
GST_API GType _gst_bitmask_type;
/**
* GstBitmask:
*
* A fundamental type that describes a 64-bit bitmask
*/
/**
* GST_TYPE_BITMASK:
*
@ -324,6 +373,13 @@ GST_API GType _gst_bitmask_type;
GST_API GType _gst_flagset_type;
/**
* GstFlagSet:
*
* A fundamental type that describes a 32-bit flag bitfield, with 32-bit
* mask indicating which of the bits in the field are explicitly set.
*/
/**
* GST_TYPE_FLAG_SET:
*