From bdea7633cd2bf5e4aff9052b18300f7e6faba6d0 Mon Sep 17 00:00:00 2001 From: Thomas Vander Stichele Date: Sun, 18 May 2003 15:03:34 +0000 Subject: [PATCH] a bunch of gtk-doc fixes Original commit message from CVS: a bunch of gtk-doc fixes --- gst/autoplug/gstsearchfuncs.c | 14 +++++++------- gst/elements/gstaggregator.h | 2 +- gst/elements/gstfilesink.h | 2 +- gst/elements/gstfilesrc.h | 2 +- gst/elements/gstmultidisksrc.h | 2 +- gst/elements/gstmultifilesrc.h | 2 +- gst/elements/gstpipefilter.h | 2 +- gst/elements/gstshaper.h | 2 +- gst/gstatomic.h | 4 +++- gst/gstpad.c | 2 +- gst/gstprops.c | 6 +++--- gst/gsttrashstack.h | 9 ++++++--- gst/parse/grammar.y | 2 +- gst/parse/types.h | 2 +- gst/registries/gstxmlregistry.h | 4 ++-- gst/schedulers/gthread-cothreads.h | 2 +- plugins/elements/gstaggregator.h | 2 +- plugins/elements/gstfilesink.h | 2 +- plugins/elements/gstfilesrc.h | 2 +- plugins/elements/gstmultidisksrc.h | 2 +- plugins/elements/gstmultifilesrc.h | 2 +- plugins/elements/gstpipefilter.h | 2 +- plugins/elements/gstshaper.h | 2 +- 23 files changed, 39 insertions(+), 34 deletions(-) diff --git a/gst/autoplug/gstsearchfuncs.c b/gst/autoplug/gstsearchfuncs.c index 2308eae..d428fc1 100644 --- a/gst/autoplug/gstsearchfuncs.c +++ b/gst/autoplug/gstsearchfuncs.c @@ -45,7 +45,7 @@ g_list_free_list_and_elements (GList *list) * * Checks if the given caps have a non-null intersection. * - * Return: TRUE, if both caps intersect. + * Returns: TRUE, if both caps intersect. */ gboolean 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 * - * Return: TRUE, if a connection can be established. + * Returns: #GstPadTemplate that can connect to the given caps */ GstPadTemplate * 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: * @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 * - * Return: TRUE, if a connection can be established. + * Returns: #GstPadTemplate that can connect to the given caps */ GstPadTemplate * 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: - * @srccaps: a #GstCaps to plug from. - * @sinkcaps: the #GstCaps to plug to. + * @src_caps: a #GstCaps to plug from. + * @sink_caps: the #GstCaps to plug to. * @factories: a #GList containing all allowed #GstElementFactory entries. * * 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. */ 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; guint curcost = GST_AUTOPLUG_MAX_COST; /* below this cost, there is no path */ diff --git a/gst/elements/gstaggregator.h b/gst/elements/gstaggregator.h index 4dff593..cd73803 100644 --- a/gst/elements/gstaggregator.h +++ b/gst/elements/gstaggregator.h @@ -33,7 +33,7 @@ extern GstElementDetails gst_aggregator_details; typedef enum { AGGREGATOR_LOOP = 1, AGGREGATOR_LOOP_SELECT, - AGGREGATOR_CHAIN, + AGGREGATOR_CHAIN } GstAggregatorSchedType; #define GST_TYPE_AGGREGATOR \ diff --git a/gst/elements/gstfilesink.h b/gst/elements/gstfilesink.h index 76ffb81..b9da688 100644 --- a/gst/elements/gstfilesink.h +++ b/gst/elements/gstfilesink.h @@ -50,7 +50,7 @@ typedef struct _GstFileSinkClass GstFileSinkClass; typedef enum { 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; struct _GstFileSink { diff --git a/gst/elements/gstfilesrc.h b/gst/elements/gstfilesrc.h index f40a1e0..25d27b0 100644 --- a/gst/elements/gstfilesrc.h +++ b/gst/elements/gstfilesrc.h @@ -44,7 +44,7 @@ G_BEGIN_DECLS typedef enum { 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; typedef struct _GstFileSrc GstFileSrc; diff --git a/gst/elements/gstmultidisksrc.h b/gst/elements/gstmultidisksrc.h index 3b1a9f4..eca04e1 100644 --- a/gst/elements/gstmultidisksrc.h +++ b/gst/elements/gstmultidisksrc.h @@ -44,7 +44,7 @@ GstElementDetails gst_multidisksrc_details; typedef enum { 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; typedef struct _GstMultiDiskSrc GstMultiDiskSrc; diff --git a/gst/elements/gstmultifilesrc.h b/gst/elements/gstmultifilesrc.h index 3b1a9f4..eca04e1 100644 --- a/gst/elements/gstmultifilesrc.h +++ b/gst/elements/gstmultifilesrc.h @@ -44,7 +44,7 @@ GstElementDetails gst_multidisksrc_details; typedef enum { 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; typedef struct _GstMultiDiskSrc GstMultiDiskSrc; diff --git a/gst/elements/gstpipefilter.h b/gst/elements/gstpipefilter.h index 6d5ea4c..7699f4e 100644 --- a/gst/elements/gstpipefilter.h +++ b/gst/elements/gstpipefilter.h @@ -47,7 +47,7 @@ GstElementDetails gst_pipefilter_details; typedef enum { 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; typedef struct _GstPipefilter GstPipefilter; diff --git a/gst/elements/gstshaper.h b/gst/elements/gstshaper.h index 8e8e6fe..40540b1 100644 --- a/gst/elements/gstshaper.h +++ b/gst/elements/gstshaper.h @@ -46,7 +46,7 @@ GstElementDetails gst_shaper_details; typedef enum { SHAPER_POLICY_TIMESTAMPS = 1, - SHAPER_POLICY_BUFFERSIZE, + SHAPER_POLICY_BUFFERSIZE } GstShaperPolicyType; typedef struct _GstShaper GstShaper; diff --git a/gst/gstatomic.h b/gst/gstatomic.h index 03bf3b1..c8355ea 100644 --- a/gst/gstatomic.h +++ b/gst/gstatomic.h @@ -24,10 +24,12 @@ G_BEGIN_DECLS +typedef volatile gint gst_vgint; /* gtk-doc volatile workaround */ + typedef struct _GstAtomicInt GstAtomicInt; struct _GstAtomicInt { - volatile gint counter; + gst_vgint counter; GMutex *lock; /* for C fallback */ }; diff --git a/gst/gstpad.c b/gst/gstpad.c index 1d29143..52c4dac 100644 --- a/gst/gstpad.c +++ b/gst/gstpad.c @@ -2706,7 +2706,7 @@ gst_ghost_pad_dispose (GObject *object) * * 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 - * 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. */ diff --git a/gst/gstprops.c b/gst/gstprops.c index a983ddc..e129219 100644 --- a/gst/gstprops.c +++ b/gst/gstprops.c @@ -185,7 +185,7 @@ gst_props_transform_to_string (const GValue *src_value, GValue *dest_value) if (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 * null-terminated. In all other cases it will be. * 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; GstPropsType type = GST_PROPS_INVALID_TYPE; /* [TYPE=]VALUE */ - /** + /* * valid type identifiers case insensitive: * INT: "i", "int" * FLOAT: "f", "float" @@ -539,7 +539,7 @@ error: GstProps * gst_props_from_string (gchar *str) { - /** + /* * format to parse is ENTRY[,ENTRY ...] * ENTRY is NAME[:TYPE]=VALUE * NAME is alphanumeric diff --git a/gst/gsttrashstack.h b/gst/gsttrashstack.h index b814dfc..b291475 100644 --- a/gst/gsttrashstack.h +++ b/gst/gsttrashstack.h @@ -32,10 +32,13 @@ struct _GstTrashStackElement { GstTrashStackElement *next; }; +typedef volatile gpointer gst_vgpointer;/* gtk-doc volatile workaround */ +typedef volatile gulong gst_vgulong; /* gtk-doc volatile workaround */ + struct _GstTrashStack { - volatile gpointer head; - volatile gulong count; /* for the ABA problem */ - GMutex *lock; /* lock for C fallback */ + gst_vgpointer head; + gst_vgulong count; /* for the ABA problem */ + GMutex *lock; /* lock for C fallback */ }; GST_INLINE_FUNC GstTrashStack* gst_trash_stack_new (void); diff --git a/gst/parse/grammar.y b/gst/parse/grammar.y index aacf73f..acac201 100644 --- a/gst/parse/grammar.y +++ b/gst/parse/grammar.y @@ -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 - * return values: 0 - link performed + * return values 0 - link performed * 1 - link delayed * <0 - error */ diff --git a/gst/parse/types.h b/gst/parse/types.h index f992198..ffc7643 100644 --- a/gst/parse/types.h +++ b/gst/parse/types.h @@ -34,7 +34,7 @@ struct _graph_t { }; -/** +/* * Memory checking. Should probably be done with gsttrace stuff, but that * doesn't really work. * This is not safe from reentrance issues, but that doesn't matter as long as diff --git a/gst/registries/gstxmlregistry.h b/gst/registries/gstxmlregistry.h index c030b37..33f08c4 100644 --- a/gst/registries/gstxmlregistry.h +++ b/gst/registries/gstxmlregistry.h @@ -53,12 +53,12 @@ typedef enum { GST_XML_REGISTRY_PADTEMPLATE, GST_XML_REGISTRY_CAPS, GST_XML_REGISTRY_CAPSCOMP, - GST_XML_REGISTRY_PROPERTIES, + GST_XML_REGISTRY_PROPERTIES } GstXMLRegistryState; typedef enum { GST_XML_REGISTRY_READ, - GST_XML_REGISTRY_WRITE, + GST_XML_REGISTRY_WRITE } GstXMLRegistryMode; typedef void (*GstXMLRegistryGetPerms) (GstXMLRegistry *registry); diff --git a/gst/schedulers/gthread-cothreads.h b/gst/schedulers/gthread-cothreads.h index ed455eb..efee576 100644 --- a/gst/schedulers/gthread-cothreads.h +++ b/gst/schedulers/gthread-cothreads.h @@ -27,7 +27,7 @@ #define COTHREADS_NAME "gthread" #define COTHREADS_NAME_CAPITAL "GThread" -/** +/* * Theory of operation: * 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 diff --git a/plugins/elements/gstaggregator.h b/plugins/elements/gstaggregator.h index 4dff593..cd73803 100644 --- a/plugins/elements/gstaggregator.h +++ b/plugins/elements/gstaggregator.h @@ -33,7 +33,7 @@ extern GstElementDetails gst_aggregator_details; typedef enum { AGGREGATOR_LOOP = 1, AGGREGATOR_LOOP_SELECT, - AGGREGATOR_CHAIN, + AGGREGATOR_CHAIN } GstAggregatorSchedType; #define GST_TYPE_AGGREGATOR \ diff --git a/plugins/elements/gstfilesink.h b/plugins/elements/gstfilesink.h index 76ffb81..b9da688 100644 --- a/plugins/elements/gstfilesink.h +++ b/plugins/elements/gstfilesink.h @@ -50,7 +50,7 @@ typedef struct _GstFileSinkClass GstFileSinkClass; typedef enum { 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; struct _GstFileSink { diff --git a/plugins/elements/gstfilesrc.h b/plugins/elements/gstfilesrc.h index f40a1e0..25d27b0 100644 --- a/plugins/elements/gstfilesrc.h +++ b/plugins/elements/gstfilesrc.h @@ -44,7 +44,7 @@ G_BEGIN_DECLS typedef enum { 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; typedef struct _GstFileSrc GstFileSrc; diff --git a/plugins/elements/gstmultidisksrc.h b/plugins/elements/gstmultidisksrc.h index 3b1a9f4..eca04e1 100644 --- a/plugins/elements/gstmultidisksrc.h +++ b/plugins/elements/gstmultidisksrc.h @@ -44,7 +44,7 @@ GstElementDetails gst_multidisksrc_details; typedef enum { 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; typedef struct _GstMultiDiskSrc GstMultiDiskSrc; diff --git a/plugins/elements/gstmultifilesrc.h b/plugins/elements/gstmultifilesrc.h index 3b1a9f4..eca04e1 100644 --- a/plugins/elements/gstmultifilesrc.h +++ b/plugins/elements/gstmultifilesrc.h @@ -44,7 +44,7 @@ GstElementDetails gst_multidisksrc_details; typedef enum { 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; typedef struct _GstMultiDiskSrc GstMultiDiskSrc; diff --git a/plugins/elements/gstpipefilter.h b/plugins/elements/gstpipefilter.h index 6d5ea4c..7699f4e 100644 --- a/plugins/elements/gstpipefilter.h +++ b/plugins/elements/gstpipefilter.h @@ -47,7 +47,7 @@ GstElementDetails gst_pipefilter_details; typedef enum { 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; typedef struct _GstPipefilter GstPipefilter; diff --git a/plugins/elements/gstshaper.h b/plugins/elements/gstshaper.h index 8e8e6fe..40540b1 100644 --- a/plugins/elements/gstshaper.h +++ b/plugins/elements/gstshaper.h @@ -46,7 +46,7 @@ GstElementDetails gst_shaper_details; typedef enum { SHAPER_POLICY_TIMESTAMPS = 1, - SHAPER_POLICY_BUFFERSIZE, + SHAPER_POLICY_BUFFERSIZE } GstShaperPolicyType; typedef struct _GstShaper GstShaper; -- 2.7.4