diff options
author | Wim Taymans <wim.taymans@gmail.com> | 2005-11-09 15:10:32 +0000 |
---|---|---|
committer | Wim Taymans <wim.taymans@gmail.com> | 2005-11-09 15:10:32 +0000 |
commit | dd937f3fea3841977cb7e04585700d09e9577709 (patch) | |
tree | 14e32fab9713b00178ea8cdb35bd93bde417f8e9 /gst/gststructure.h | |
parent | 27e5e2480f4a686e5b124e14d5e5b0a22e2852ba (diff) |
gst/gstbin.h: Document another field.
Original commit message from CVS:
* gst/gstbin.h:
Document another field.
* gst/gststructure.c:
* gst/gststructure.h:
Document.
Diffstat (limited to 'gst/gststructure.h')
-rw-r--r-- | gst/gststructure.h | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/gst/gststructure.h b/gst/gststructure.h index 399acfb9e..766ce02f0 100644 --- a/gst/gststructure.h +++ b/gst/gststructure.h @@ -32,14 +32,42 @@ G_BEGIN_DECLS typedef struct _GstStructure GstStructure; +/** + * GstStructureForeachFunc: + * @field_id: the #GQuark of the field name + * @value: the #GValue of the field + * @user_data: user data + * + * A function that will be called in gst_structure_foreach() + * + * Returns: TRUE if the foreach operation should continue, FALSE if + * the foreach operation should stop with FALSE. + */ typedef gboolean (*GstStructureForeachFunc) (GQuark field_id, const GValue * value, gpointer user_data); +/** + * GstStructureMapFunc: + * @field_id: the #GQuark of the field name + * @value: the #GValue of the field + * @user_data: user data + * + * A function that will be called in gst_structure_map_in_place() + * + * Returns: TRUE if the map operation should continue, FALSE if + * the map operation should stop with FALSE. + */ typedef gboolean (*GstStructureMapFunc) (GQuark field_id, GValue * value, gpointer user_data); +/** + * GstStructure: + * @type: the GType of a structure + * + * The GstStructure object. Most fields are private. + */ struct _GstStructure { GType type; |