event: Improve documentation of gst_event_new_reconfigure()

diff --git a/gst/gstevent.c b/gst/gstevent.c
index 471e87a1987d7b31354fada8dba56dcef2c04b09..9e4390cd32d8271ce3e006dab5491680691b28e1 100644 (file)
--- a/gst/gstevent.c
+++ b/gst/gstevent.c
@@ -1285,9 +1285,10 @@ gst_event_parse_step (GstEvent * event, GstFormat * format, guint64 * amount,
 /**
  * gst_event_new_reconfigure:
 
- * Create a new reconfigure event. The purpose of the step event is to travel
- * upstream and make elements renegotiate its caps. This is useful when changing
- * properties or elements on the pipeline.
+ * Create a new reconfigure event. The purpose of the reconfingure event is
+ * to travel upstream and make elements renegotiate their caps or reconfigure
+ * their buffer pools. This is useful when changing properties on elements
+ * or changing the topology of the pipeline.
  *
  * Returns: (transfer full): a new #GstEvent
  *