mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-12-22 08:17:01 +00:00
Code Issues 1 Projects Releases Wiki Activity

a bunch of gtk-doc fixes

Browse source 
Original commit message from CVS:
a bunch of gtk-doc fixes
This commit is contained in:
Thomas Vander Stichele 2003-05-18 15:03:34 +00:00
parent 1a87d5538b
commit bdea7633cd
23 changed files with 39 additions and 34 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
gst/autoplug/gstsearchfuncs.c
View file

@ -45,7 +45,7 @@ g_list_free_list_and_elements (GList *list)
* *
* Checks if the given caps have a non-null intersection. * Checks if the given caps have a non-null intersection.
* *
* Return: TRUE, if both caps intersect. * Returns: TRUE, if both caps intersect.
*/ */
gboolean gboolean
gst_autoplug_caps_intersect (GstCaps *src, GstCaps *sink) gst_autoplug_caps_intersect (GstCaps *src, GstCaps *sink)
@ -75,7 +75,7 @@ gst_autoplug_caps_intersect (GstCaps *src, GstCaps *sink)
* *
* Checks if a factory's sink can connect to the given caps * Checks if a factory's sink can connect to the given caps
* *
* Return: TRUE, if a connection can be established. * Returns: #GstPadTemplate that can connect to the given caps
*/ */
GstPadTemplate * GstPadTemplate *
gst_autoplug_can_connect_src (GstElementFactory *fac, GstCaps *src) gst_autoplug_can_connect_src (GstElementFactory *fac, GstCaps *src)
@ -100,11 +100,11 @@ gst_autoplug_can_connect_src (GstElementFactory *fac, GstCaps *src)
/** /**
* gst_autoplug_can_connect_sink: * gst_autoplug_can_connect_sink:
* @fac: factory to connect to * @fac: factory to connect to
* @src: caps to check * @sink: caps to check
* *
* Checks if a factory's src can connect to the given caps * Checks if a factory's src can connect to the given caps
* *
* Return: TRUE, if a connection can be established. * Returns: #GstPadTemplate that can connect to the given caps
*/ */
GstPadTemplate * GstPadTemplate *
gst_autoplug_can_connect_sink (GstElementFactory *fac, GstCaps *sink) gst_autoplug_can_connect_sink (GstElementFactory *fac, GstCaps *sink)
@ -311,8 +311,8 @@ gst_autoplug_factories_at_most_templates(GList *factories, GstPadDirection dir,
*/ */
/** /**
* gst_autoplug_sp: * gst_autoplug_sp:
* @srccaps: a #GstCaps to plug from. * @src_caps: a #GstCaps to plug from.
* @sinkcaps: the #GstCaps to plug to. * @sink_caps: the #GstCaps to plug to.
* @factories: a #GList containing all allowed #GstElementFactory entries. * @factories: a #GList containing all allowed #GstElementFactory entries.
* *
* Finds the shortest path of elements that together make up a possible * Finds the shortest path of elements that together make up a possible
@ -322,7 +322,7 @@ gst_autoplug_factories_at_most_templates(GList *factories, GstPadDirection dir,
* to get the shortest path. * to get the shortest path.
*/ */
GList * GList *
gst_autoplug_sp (GstCaps *srccaps, GstCaps *sinkcaps, GList *factories) gst_autoplug_sp (GstCaps *src_caps, GstCaps *sink_caps, GList *factories)
{ {
GList *factory_nodes = NULL; GList *factory_nodes = NULL;
guint curcost = GST_AUTOPLUG_MAX_COST; /* below this cost, there is no path */ guint curcost = GST_AUTOPLUG_MAX_COST; /* below this cost, there is no path */

2
gst/elements/gstaggregator.h
View file

@ -33,7 +33,7 @@ extern GstElementDetails gst_aggregator_details;
typedef enum { typedef enum {
AGGREGATOR_LOOP = 1, AGGREGATOR_LOOP = 1,
AGGREGATOR_LOOP_SELECT, AGGREGATOR_LOOP_SELECT,
AGGREGATOR_CHAIN, AGGREGATOR_CHAIN
} GstAggregatorSchedType; } GstAggregatorSchedType;
#define GST_TYPE_AGGREGATOR \ #define GST_TYPE_AGGREGATOR \

2
gst/elements/gstfilesink.h
View file

@ -50,7 +50,7 @@ typedef struct _GstFileSinkClass GstFileSinkClass;
typedef enum { typedef enum {
GST_FILESINK_OPEN = GST_ELEMENT_FLAG_LAST, GST_FILESINK_OPEN = GST_ELEMENT_FLAG_LAST,
GST_FILESINK_FLAG_LAST = GST_ELEMENT_FLAG_LAST + 2, GST_FILESINK_FLAG_LAST = GST_ELEMENT_FLAG_LAST + 2
} GstFileSinkFlags; } GstFileSinkFlags;
struct _GstFileSink { struct _GstFileSink {

2
gst/elements/gstfilesrc.h
View file

@ -44,7 +44,7 @@ G_BEGIN_DECLS
typedef enum { typedef enum {
GST_FILESRC_OPEN = GST_ELEMENT_FLAG_LAST, GST_FILESRC_OPEN = GST_ELEMENT_FLAG_LAST,
GST_FILESRC_FLAG_LAST = GST_ELEMENT_FLAG_LAST + 2, GST_FILESRC_FLAG_LAST = GST_ELEMENT_FLAG_LAST + 2
} GstFileSrcFlags; } GstFileSrcFlags;
typedef struct _GstFileSrc GstFileSrc; typedef struct _GstFileSrc GstFileSrc;

2
gst/elements/gstmultidisksrc.h
View file

@ -44,7 +44,7 @@ GstElementDetails gst_multidisksrc_details;
typedef enum { typedef enum {
GST_MULTIDISKSRC_OPEN = GST_ELEMENT_FLAG_LAST, GST_MULTIDISKSRC_OPEN = GST_ELEMENT_FLAG_LAST,
GST_MULTIDISKSRC_FLAG_LAST = GST_ELEMENT_FLAG_LAST + 2, GST_MULTIDISKSRC_FLAG_LAST = GST_ELEMENT_FLAG_LAST + 2
} GstMultiDiskSrcFlags; } GstMultiDiskSrcFlags;
typedef struct _GstMultiDiskSrc GstMultiDiskSrc; typedef struct _GstMultiDiskSrc GstMultiDiskSrc;

2
gst/elements/gstmultifilesrc.h
View file

@ -44,7 +44,7 @@ GstElementDetails gst_multidisksrc_details;
typedef enum { typedef enum {
GST_MULTIDISKSRC_OPEN = GST_ELEMENT_FLAG_LAST, GST_MULTIDISKSRC_OPEN = GST_ELEMENT_FLAG_LAST,
GST_MULTIDISKSRC_FLAG_LAST = GST_ELEMENT_FLAG_LAST + 2, GST_MULTIDISKSRC_FLAG_LAST = GST_ELEMENT_FLAG_LAST + 2
} GstMultiDiskSrcFlags; } GstMultiDiskSrcFlags;
typedef struct _GstMultiDiskSrc GstMultiDiskSrc; typedef struct _GstMultiDiskSrc GstMultiDiskSrc;

2
gst/elements/gstpipefilter.h
View file

@ -47,7 +47,7 @@ GstElementDetails gst_pipefilter_details;
typedef enum { typedef enum {
GST_PIPEFILTER_OPEN = GST_ELEMENT_FLAG_LAST, GST_PIPEFILTER_OPEN = GST_ELEMENT_FLAG_LAST,
GST_PIPEFILTER_FLAG_LAST = GST_ELEMENT_FLAG_LAST, GST_PIPEFILTER_FLAG_LAST = GST_ELEMENT_FLAG_LAST + 2
} GstPipeFilterFlags; } GstPipeFilterFlags;
typedef struct _GstPipefilter GstPipefilter; typedef struct _GstPipefilter GstPipefilter;

2
gst/elements/gstshaper.h
View file

@ -46,7 +46,7 @@ GstElementDetails gst_shaper_details;
typedef enum { typedef enum {
SHAPER_POLICY_TIMESTAMPS = 1, SHAPER_POLICY_TIMESTAMPS = 1,
SHAPER_POLICY_BUFFERSIZE, SHAPER_POLICY_BUFFERSIZE
} GstShaperPolicyType; } GstShaperPolicyType;
typedef struct _GstShaper GstShaper; typedef struct _GstShaper GstShaper;

4
gst/gstatomic.h
View file

@ -24,10 +24,12 @@
G_BEGIN_DECLS G_BEGIN_DECLS
typedef volatile gint gst_vgint; /* gtk-doc volatile workaround */
typedef struct _GstAtomicInt GstAtomicInt; typedef struct _GstAtomicInt GstAtomicInt;
struct _GstAtomicInt { struct _GstAtomicInt {
volatile gint counter; gst_vgint counter;
GMutex *lock; /* for C fallback */ GMutex *lock; /* for C fallback */
}; };

2
gst/gstpad.c
View file

@ -2706,7 +2706,7 @@ gst_ghost_pad_dispose (GObject *object)
* *
* Creates a new ghost pad associated with the given pad, and names it with * Creates a new ghost pad associated with the given pad, and names it with
* the given name. If name is NULL, a guaranteed unique name (across all * the given name. If name is NULL, a guaranteed unique name (across all
* ghost pads) will be assigned (most likely of the form ghostpad&perc;d). * ghost pads) will be assigned (most likely of the form ghostpad%d).
* *
* Returns: a new ghost #GstPad, or NULL in case of an error. * Returns: a new ghost #GstPad, or NULL in case of an error.
*/ */

6
gst/gstprops.c
View file

@ -185,7 +185,7 @@ gst_props_transform_to_string (const GValue *src_value, GValue *dest_value)
if (props) if (props)
dest_value->data[0].v_pointer = gst_props_to_string (props); dest_value->data[0].v_pointer = gst_props_to_string (props);
} }
/** /*
* r will still point to the string. if end == next, the string will not be * r will still point to the string. if end == next, the string will not be
* null-terminated. In all other cases it will be. * null-terminated. In all other cases it will be.
* end = pointer to char behind end of string, next = pointer to start of * end = pointer to char behind end of string, next = pointer to start of
@ -258,7 +258,7 @@ gst_props_entry_from_string_no_name (gchar *s, gchar **after, gboolean has_type)
gchar *end, *next, *check = s; gchar *end, *next, *check = s;
GstPropsType type = GST_PROPS_INVALID_TYPE; GstPropsType type = GST_PROPS_INVALID_TYPE;
/* [TYPE=]VALUE */ /* [TYPE=]VALUE */
/** /*
* valid type identifiers case insensitive: * valid type identifiers case insensitive:
* INT: "i", "int" * INT: "i", "int"
* FLOAT: "f", "float" * FLOAT: "f", "float"
@ -539,7 +539,7 @@ error:
GstProps * GstProps *
gst_props_from_string (gchar *str) gst_props_from_string (gchar *str)
{ {
/** /*
* format to parse is ENTRY[,ENTRY ...] * format to parse is ENTRY[,ENTRY ...]
* ENTRY is NAME[:TYPE]=VALUE * ENTRY is NAME[:TYPE]=VALUE
* NAME is alphanumeric * NAME is alphanumeric

9
gst/gsttrashstack.h
View file

@ -32,10 +32,13 @@ struct _GstTrashStackElement {
GstTrashStackElement *next; GstTrashStackElement *next;
}; };
typedef volatile gpointer gst_vgpointer;/* gtk-doc volatile workaround */
typedef volatile gulong gst_vgulong; /* gtk-doc volatile workaround */
struct _GstTrashStack { struct _GstTrashStack {
volatile gpointer head; gst_vgpointer head;
volatile gulong count; /* for the ABA problem */ gst_vgulong count; /* for the ABA problem */
GMutex *lock; /* lock for C fallback */ GMutex *lock; /* lock for C fallback */
}; };
GST_INLINE_FUNC GstTrashStack* gst_trash_stack_new (void); GST_INLINE_FUNC GstTrashStack* gst_trash_stack_new (void);

2
gst/parse/grammar.y
View file

@ -450,7 +450,7 @@ gst_parse_perform_delayed_link (GstElement *src, const gchar *src_pad,
} }
/** /**
* performs a link and frees the struct. src and sink elements must be given * performs a link and frees the struct. src and sink elements must be given
* return values: 0 - link performed * return values 0 - link performed
* 1 - link delayed * 1 - link delayed
* <0 - error * <0 - error
*/ */

2
gst/parse/types.h
View file

@ -34,7 +34,7 @@ struct _graph_t {
}; };
/** /*
* Memory checking. Should probably be done with gsttrace stuff, but that * Memory checking. Should probably be done with gsttrace stuff, but that
* doesn't really work. * doesn't really work.
* This is not safe from reentrance issues, but that doesn't matter as long as * This is not safe from reentrance issues, but that doesn't matter as long as

4
gst/registries/gstxmlregistry.h
View file

@ -53,12 +53,12 @@ typedef enum {
GST_XML_REGISTRY_PADTEMPLATE, GST_XML_REGISTRY_PADTEMPLATE,
GST_XML_REGISTRY_CAPS, GST_XML_REGISTRY_CAPS,
GST_XML_REGISTRY_CAPSCOMP, GST_XML_REGISTRY_CAPSCOMP,
GST_XML_REGISTRY_PROPERTIES, GST_XML_REGISTRY_PROPERTIES
} GstXMLRegistryState; } GstXMLRegistryState;
typedef enum { typedef enum {
GST_XML_REGISTRY_READ, GST_XML_REGISTRY_READ,
GST_XML_REGISTRY_WRITE, GST_XML_REGISTRY_WRITE
} GstXMLRegistryMode; } GstXMLRegistryMode;
typedef void (*GstXMLRegistryGetPerms) (GstXMLRegistry *registry); typedef void (*GstXMLRegistryGetPerms) (GstXMLRegistry *registry);

2
gst/schedulers/gthread-cothreads.h
View file

@ -27,7 +27,7 @@
#define COTHREADS_NAME "gthread" #define COTHREADS_NAME "gthread"
#define COTHREADS_NAME_CAPITAL "GThread" #define COTHREADS_NAME_CAPITAL "GThread"
/** /*
* Theory of operation: * Theory of operation:
* Instead of using cothreads, GThreads and 1 mutex are used. * Instead of using cothreads, GThreads and 1 mutex are used.
* Every thread may only run if it holds the mutex. Otherwise it holds its own * Every thread may only run if it holds the mutex. Otherwise it holds its own

2
plugins/elements/gstaggregator.h
View file

@ -33,7 +33,7 @@ extern GstElementDetails gst_aggregator_details;
typedef enum { typedef enum {
AGGREGATOR_LOOP = 1, AGGREGATOR_LOOP = 1,
AGGREGATOR_LOOP_SELECT, AGGREGATOR_LOOP_SELECT,
AGGREGATOR_CHAIN, AGGREGATOR_CHAIN
} GstAggregatorSchedType; } GstAggregatorSchedType;
#define GST_TYPE_AGGREGATOR \ #define GST_TYPE_AGGREGATOR \

2
plugins/elements/gstfilesink.h
View file

@ -50,7 +50,7 @@ typedef struct _GstFileSinkClass GstFileSinkClass;
typedef enum { typedef enum {
GST_FILESINK_OPEN = GST_ELEMENT_FLAG_LAST, GST_FILESINK_OPEN = GST_ELEMENT_FLAG_LAST,
GST_FILESINK_FLAG_LAST = GST_ELEMENT_FLAG_LAST + 2, GST_FILESINK_FLAG_LAST = GST_ELEMENT_FLAG_LAST + 2
} GstFileSinkFlags; } GstFileSinkFlags;
struct _GstFileSink { struct _GstFileSink {

2
plugins/elements/gstfilesrc.h
View file

@ -44,7 +44,7 @@ G_BEGIN_DECLS
typedef enum { typedef enum {
GST_FILESRC_OPEN = GST_ELEMENT_FLAG_LAST, GST_FILESRC_OPEN = GST_ELEMENT_FLAG_LAST,
GST_FILESRC_FLAG_LAST = GST_ELEMENT_FLAG_LAST + 2, GST_FILESRC_FLAG_LAST = GST_ELEMENT_FLAG_LAST + 2
} GstFileSrcFlags; } GstFileSrcFlags;
typedef struct _GstFileSrc GstFileSrc; typedef struct _GstFileSrc GstFileSrc;

2
plugins/elements/gstmultidisksrc.h
View file

@ -44,7 +44,7 @@ GstElementDetails gst_multidisksrc_details;
typedef enum { typedef enum {
GST_MULTIDISKSRC_OPEN = GST_ELEMENT_FLAG_LAST, GST_MULTIDISKSRC_OPEN = GST_ELEMENT_FLAG_LAST,
GST_MULTIDISKSRC_FLAG_LAST = GST_ELEMENT_FLAG_LAST + 2, GST_MULTIDISKSRC_FLAG_LAST = GST_ELEMENT_FLAG_LAST + 2
} GstMultiDiskSrcFlags; } GstMultiDiskSrcFlags;
typedef struct _GstMultiDiskSrc GstMultiDiskSrc; typedef struct _GstMultiDiskSrc GstMultiDiskSrc;

2
plugins/elements/gstmultifilesrc.h
View file

@ -44,7 +44,7 @@ GstElementDetails gst_multidisksrc_details;
typedef enum { typedef enum {
GST_MULTIDISKSRC_OPEN = GST_ELEMENT_FLAG_LAST, GST_MULTIDISKSRC_OPEN = GST_ELEMENT_FLAG_LAST,
GST_MULTIDISKSRC_FLAG_LAST = GST_ELEMENT_FLAG_LAST + 2, GST_MULTIDISKSRC_FLAG_LAST = GST_ELEMENT_FLAG_LAST + 2
} GstMultiDiskSrcFlags; } GstMultiDiskSrcFlags;
typedef struct _GstMultiDiskSrc GstMultiDiskSrc; typedef struct _GstMultiDiskSrc GstMultiDiskSrc;

2
plugins/elements/gstpipefilter.h
View file

@ -47,7 +47,7 @@ GstElementDetails gst_pipefilter_details;
typedef enum { typedef enum {
GST_PIPEFILTER_OPEN = GST_ELEMENT_FLAG_LAST, GST_PIPEFILTER_OPEN = GST_ELEMENT_FLAG_LAST,
GST_PIPEFILTER_FLAG_LAST = GST_ELEMENT_FLAG_LAST, GST_PIPEFILTER_FLAG_LAST = GST_ELEMENT_FLAG_LAST + 2
} GstPipeFilterFlags; } GstPipeFilterFlags;
typedef struct _GstPipefilter GstPipefilter; typedef struct _GstPipefilter GstPipefilter;

2
plugins/elements/gstshaper.h
View file

@ -46,7 +46,7 @@ GstElementDetails gst_shaper_details;
typedef enum { typedef enum {
SHAPER_POLICY_TIMESTAMPS = 1, SHAPER_POLICY_TIMESTAMPS = 1,
SHAPER_POLICY_BUFFERSIZE, SHAPER_POLICY_BUFFERSIZE
} GstShaperPolicyType; } GstShaperPolicyType;
typedef struct _GstShaper GstShaper; typedef struct _GstShaper GstShaper;