From d29c31f9cd2d98d0cf3bda76c1249e602f1d5f11 Mon Sep 17 00:00:00 2001
From: Stefan Kost <ensonic@ensonic-desktop.localdomain>
Date: Sun, 4 Apr 2010 15:21:16 +0300
Subject: [PATCH] docs: improve event docs

Rephrase first paragraph of section docs. Add detail to eos event docs.
---
 gst/gstevent.c | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/gst/gstevent.c b/gst/gstevent.c
index f22431fc3b..fa36d1cba7 100644
--- a/gst/gstevent.c
+++ b/gst/gstevent.c
@@ -27,8 +27,8 @@
  *                     a pipeline
  * @see_also: #GstPad, #GstElement
  *
- * The event class provides factory methods to construct and functions query
- * (parse) events.
+ * The event class provides factory methods to construct event for sending
+ * and functions to query (parse) received events.
  *
  * Events are usually created with gst_event_new_*() which takes event-type
  * specific parameters as arguments.
@@ -476,6 +476,8 @@ gst_event_new_flush_stop (void)
  * When all sinks have posted an EOS message, an EOS message is
  * forwarded to the application.
  *
+ * The EOS event itself will no cause any state transitions of the pipeline.
+ *
  * Returns: The new EOS event.
  */
 GstEvent *