gst/gstevent.c: Document that gst_event_new_tag() and gst_event_new_navigation()...

Original commit message from CVS:
* gst/gstevent.c:
Document that gst_event_new_tag() and gst_event_new_navigation()
take ownership of the taglist/structure passed to them. (#533635).

diff --git a/ChangeLog b/ChangeLog
index 2a4ce19..ce9025f 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+2008-05-18  Tim-Philipp Müller  <tim.muller at collabora co uk>
+
+       * gst/gstevent.c:
+         Document that gst_event_new_tag() and gst_event_new_navigation()
+         take ownership of the taglist/structure passed to them. (#533635).
+
 2008-05-17  Jan Schmidt  <jan.schmidt@sun.com>
 
        * docs/Makefile.am:

diff --git a/gst/gstevent.c b/gst/gstevent.c
index adf8835..02bf16b 100644 (file)
--- a/gst/gstevent.c
+++ b/gst/gstevent.c
@@ -628,7 +628,7 @@ gst_event_parse_new_segment_full (GstEvent * event, gboolean * update,
 
 /**
  * gst_event_new_tag:
- * @taglist: metadata list
+ * @taglist: metadata list. The event will take ownership of @taglist.
  *
  * Generates a metadata tag event from the given @taglist.
  *
@@ -929,7 +929,8 @@ gst_event_parse_seek (GstEvent * event, gdouble * rate,
 
 /**
  * gst_event_new_navigation:
- * @structure: description of the event
+ * @structure: description of the event. The event will take ownership of the
+ *     structure.
  *
  * Create a new navigation event from the given description.
  *