summaryrefslogtreecommitdiff
path: root/gst/gstxml.c
diff options
context:
space:
mode:
authorTim-Philipp Müller <tim@centricular.net>2006-08-29 10:49:03 +0000
committerTim-Philipp Müller <tim@centricular.net>2006-08-29 10:49:03 +0000
commitab00f16f1227578dc85a409838681c9f61da70d7 (patch)
tree2c7fe8a38668949a6c992a03f7850f672d84cb88 /gst/gstxml.c
parent3f7a406618601b83b0d8ac516b8acfb5a3a56d06 (diff)
gst/gstxml.c: Improve and detypofy docs.
Original commit message from CVS: * gst/gstxml.c: Improve and detypofy docs. * tests/check/Makefile.am: * tests/check/gst/.cvsignore: * tests/check/gst/gstxml.c: (GST_START_TEST), (gst_xml_suite): Add a basic test suite for GstXML.
Diffstat (limited to 'gst/gstxml.c')
-rw-r--r--gst/gstxml.c7
1 files changed, 5 insertions, 2 deletions
diff --git a/gst/gstxml.c b/gst/gstxml.c
index d6462c918..a790aee73 100644
--- a/gst/gstxml.c
+++ b/gst/gstxml.c
@@ -377,9 +377,12 @@ gst_xml_object_loaded (GstObject * private, GstObject * object, xmlNodePtr self,
* gst_xml_get_topelements:
* @xml: The GstXML to get the elements from
*
- * Retrive a list of toplevel elements.
+ * Retrieve a list of toplevel elements.
*
- * Returns: a GList of elements
+ * Returns: a GList of top-level elements. The caller does not own a copy
+ * of the list and must not free or modify the list. The caller also does not
+ * own a reference to any of the elements in the list and should obtain its own
+ * reference using gst_object_ref() if necessary.
*/
GList *
gst_xml_get_topelements (GstXML * xml)