[gst-cvs] gstreamer: docs: more docs for gst_parse_launch and co

[Stefan Kost]

Module: gstreamer
Branch: master
Commit: d3f63b1b8764af72375afc8cbec2f8717979a88d
URL:    http://cgit.freedesktop.org/gstreamer/gstreamer/commit/?id=d3f63b1b8764af72375afc8cbec2f8717979a88d

Author: Stefan Kost <ensonic at users.sf.net>
Date:   Tue Jul  6 14:29:39 2010 +0300

docs: more docs for gst_parse_launch and co

Tell about limited reusability of some parsed pipelines.

---

 gst/gstparse.c |    7 +++++--
 1 files changed, 5 insertions(+), 2 deletions(-)

diff --git a/gst/gstparse.c b/gst/gstparse.c
index d41b97e..ca1ed7d 100644
--- a/gst/gstparse.c
+++ b/gst/gstparse.c
@@ -27,10 +27,13 @@
  * @short_description: Get a pipeline from a text pipeline description
  *
  * These function allow to create a pipeline based on the syntax used in the
- * gst-launch utility.
+ * gst-launch utility (see man-page for syntax documentation).
+ *
+ * Please note that these functions take serveral meassures to create even
+ * somewhat dynamic pipelines. Due to that such pipelines are not always
+ * reuseable (set the state to NULL and back to PLAYING).
  */
 
-
 #include "gst_private.h"
 #include <string.h>