Commit d29c31f9 authored by Stefan Kost's avatar Stefan Kost

docs: improve event docs

Rephrase first paragraph of section docs. Add detail to eos event docs.
parent 5f3d98f2
......@@ -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 *
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment