gst/gststructure.c: add some comments rename a method so that it actually says what...

Original commit message from CVS:

* gst/gststructure.c: (gst_structure_gtype_from_abbr),
(gst_structure_parse_value):
add some comments
rename a method so that it actually says what it does better

diff --git a/ChangeLog b/ChangeLog
index 9dcdf81713d751b662f4925c5d7bc84950b97f9b..f312d3cbf3a5b4788ea0b101b9ac604367e8fcd3 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2006-05-10  Thomas Vander Stichele  <thomas at apestaart dot org>
+
+       * gst/gststructure.c: (gst_structure_gtype_from_abbr),
+       (gst_structure_parse_value):
+         add some comments
+         rename a method so that it actually says what it does better
+
 2006-05-10  Thomas Vander Stichele  <thomas at apestaart dot org>
 
        * gst/gstevent.c: (_gst_event_initialize):

diff --git a/gst/gststructure.c b/gst/gststructure.c
index 8317e512ed318bb61bd12527a72832353faf8430..9ae5f017f0ba2068e11fcfbdde07aefa00204798 100644 (file)
--- a/gst/gststructure.c
+++ b/gst/gststructure.c
@@ -1227,6 +1227,8 @@ typedef struct _GstStructureAbbreviation
 }
 GstStructureAbbreviation;
 
+/* return a copy of an array of GstStructureAbbreviation containing all the
+ * known type_string, GType maps, including abbreviations for common types */
 static GstStructureAbbreviation *
 gst_structure_get_abbrs (gint * n_abbrs)
 {
@@ -1278,8 +1280,10 @@ gst_structure_get_abbrs (gint * n_abbrs)
   return abbrs;
 }
 
+/* given a type_name that could be a type abbreviation or a registered GType,
+ * return a matching GType */
 static GType
-gst_structure_from_abbr (const char *type_name)
+gst_structure_gtype_from_abbr (const char *type_name)
 {
   int i;
   GstStructureAbbreviation *abbrs;
@@ -1640,6 +1644,7 @@ gst_structure_parse_value (gchar * str,
   while (g_ascii_isspace (*s))
     s++;
 
+  /* check if there's a (type_name) 'cast' */
   type_name = NULL;
   if (*s == '(') {
     type = G_TYPE_INVALID;
@@ -1661,7 +1666,7 @@ gst_structure_parse_value (gchar * str,
 
     c = *type_end;
     *type_end = 0;
-    type = gst_structure_from_abbr (type_name);
+    type = gst_structure_gtype_from_abbr (type_name);
     *type_end = c;
 
     if (type == G_TYPE_INVALID)