From: <tp...@ke...> - 2006-08-14 12:35:19
|
CVS Root: /cvs/gstreamer Module: gstreamer Changes by: tpm Date: Mon Aug 14 2006 12:35:18 UTC Log message: * gst/gststructure.c: Fix typo in docs and re-wrap docs blurb to not exceed 80 chars/line. * gst/gstvalue.h: Expand on the difference between arrays and lists as we use them. Modified files: . : ChangeLog gst : gststructure.c gstvalue.h Links: http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gstreamer/ChangeLog.diff?r1=1.2740&r2=1.2741 http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gstreamer/gst/gststructure.c.diff?r1=1.78&r2=1.79 http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gstreamer/gst/gstvalue.h.diff?r1=1.43&r2=1.44 ====Begin Diffs==== Index: ChangeLog =================================================================== RCS file: /cvs/gstreamer/gstreamer/ChangeLog,v retrieving revision 1.2740 retrieving revision 1.2741 diff -u -d -r1.2740 -r1.2741 --- ChangeLog 14 Aug 2006 07:44:14 -0000 1.2740 +++ ChangeLog 14 Aug 2006 12:35:06 -0000 1.2741 @@ -1,3 +1,11 @@ +2006-08-14 Tim-Philipp Müller <tim at centricular dot net> + + * gst/gststructure.c: + Fix typo in docs and re-wrap docs blurb to not exceed 80 chars/line. + * gst/gstvalue.h: + Expand on the difference between arrays and lists as we use them. + 2006-08-14 Wim Taymans <wi...@fl...> * libs/gst/base/gstbasesrc.c: (gst_base_src_change_state): Index: gststructure.c RCS file: /cvs/gstreamer/gstreamer/gst/gststructure.c,v retrieving revision 1.78 retrieving revision 1.79 diff -u -d -r1.78 -r1.79 --- gststructure.c 27 Jul 2006 11:00:20 -0000 1.78 +++ gststructure.c 14 Aug 2006 12:35:06 -0000 1.79 @@ -24,27 +24,29 @@ * @short_description: Generic structure containing fields of names and values * @see_also: #GstCaps, #GstMessage, #GstEvent, #GstQuery * - * A #GstStructure is a collection of key/value pairs. The keys are expressed as - * GQuarks and the values can be of any GType. + * A #GstStructure is a collection of key/value pairs. The keys are expressed + * as GQuarks and the values can be of any GType. * In addition to the key/value pairs, a #GstStructure also has a name. * - * #GstStructure is used by various GStreamer subsystems to store information in - * a flexible an extensible way. A #GstStructure does not have a refcount because it - * usually is part of a higher level object such as #GstCaps. It provides a means to - * enforce mutability using the refcount of the parent with the - * gst_structure_set_parent_refcount() method. + * #GstStructure is used by various GStreamer subsystems to store information + * in a flexible and extensible way. A #GstStructure does not have a refcount + * because it usually is part of a higher level object such as #GstCaps. It + * provides a means to enforce mutability using the refcount of the parent + * with the gst_structure_set_parent_refcount() method. - * A #GstStructure can be created with gst_structure_empty_new() or gst_structure_new(), - * which both take a name and an optional set of key/value pairs along with the types - * of the values. + * A #GstStructure can be created with gst_structure_empty_new() or + * gst_structure_new(), which both take a name and an optional set of + * key/value pairs along with the types of the values. - * Field values can be changed with gst_structure_set_value() or gst_structure_set(). + * Field values can be changed with gst_structure_set_value() or + * gst_structure_set(). - * Field values can be retrieved with gst_structure_get_value() or the more convenient - * gst_structure_get_*() functions. + * Field values can be retrieved with gst_structure_get_value() or the more + * convenient gst_structure_get_*() functions. - * Fields can be removed with gst_structure_remove_field() or gst_structure_remove_fields(). + * Fields can be removed with gst_structure_remove_field() or + * gst_structure_remove_fields(). * Last reviewed on 2005-11-09 (0.9.4) */ @@ -975,8 +977,8 @@ * and has the correct type. * Returns: TRUE if the value could be set correctly. If there was no field - * with @fieldname or the existing field did not contain a boolean, this function - * returns FALSE. + * with @fieldname or the existing field did not contain a boolean, this + * function returns FALSE. gboolean gst_structure_get_boolean (const GstStructure * structure, Index: gstvalue.h RCS file: /cvs/gstreamer/gstreamer/gst/gstvalue.h,v retrieving revision 1.43 retrieving revision 1.44 diff -u -d -r1.43 -r1.44 --- gstvalue.h 27 Nov 2005 19:52:49 -0000 1.43 +++ gstvalue.h 14 Aug 2006 12:35:06 -0000 1.44 @@ -203,7 +203,11 @@ /** * GST_TYPE_LIST: - * a #GValue type that represents an unordered list of #GValue values + * a #GValue type that represents an unordered list of #GValue values. This + * is used for example to express a list of possible values for a field in + * a caps structure, like a list of possible sample rates, of which only one + * will be chosen in the end. This means that all values in the list are + * meaningful on their own. * Returns: the #GType of GstValueList (which is not explicitly typed) @@ -212,7 +216,12 @@ * GST_TYPE_ARRAY: - * a #GValue type that represents an ordered list of #GValue values + * a #GValue type that represents an ordered list of #GValue values. This is + * used to express a set of values that is meaningful only in their specific + * combination and order of values. Each value on its own is not particularly + * meaningful, only the ordered array in its entirety is meaningful. This is + * used for example to express channel layouts for multichannel audio where + * each channel needs to be mapped to a position in the room. * Returns: the #GType of GstArrayList (which is not explicitly typed) |