segment: small docs addition

https://bugzilla.gnome.org/show_bug.cgi?id=690564
2015-04-04 19:29:51 +01:00 · 2015-04-04 19:29:51 +01:00 · c8f680e395
commit c8f680e395
parent 199c8ba561
1 changed files with 2 additions and 1 deletions
--- a/gst/gstsegment.h
+++ b/gst/gstsegment.h
@ -179,7 +179,8 @@ typedef enum { /*< flags >*/
 * @start: the start of the segment
 * @stop: the stop of the segment
 * @time: the stream time of the segment
- * @position: the position in the segment
+ * @position: the position in the segment (used internally by elements
+ *     such as sources, demuxers or parsers to track progress)
 * @duration: the duration of the segment
 *
 * A helper structure that holds the configured region of