From: Stefan Sauer <ensonic@users.sf.net>
Date: Sun, 15 Oct 2017 08:44:44 +0000 (+0200)
Subject: aggregator: improve section docs
X-Git-Tag: 1.19.3~507^2~4816
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=6deaeec19fb68e303273f11e28352462c16ca7ef;p=platform%2Fupstream%2Fgstreamer.git

aggregator: improve section docs

Mention how data ends up in the queues. Document the relation of the pad
functions and the class vmethods to get events and queries.
---

diff --git a/gst-libs/gst/base/gstaggregator.c b/gst-libs/gst/base/gstaggregator.c
index afeb9ba2b4..864654effe 100644
--- a/gst-libs/gst/base/gstaggregator.c
+++ b/gst-libs/gst/base/gstaggregator.c
@@ -32,6 +32,12 @@
  *  * Base class for mixers and muxers. Subclasses should at least implement
  *    the #GstAggregatorClass.aggregate() virtual method.
  *
+ *  * Installs a #GstPadChainFunction, a #GstPadEventFullFunction and a
+ *    #GstPadQueryFunction to queue all serialized data packets per sink pad.
+ *    Subclasses should not overwrite those, but instead implement
+ *    #GstAggregatorClass.sink_event() and #GstAggregatorClass.sink_query() as
+ *    needed.
+ *
  *  * When data is queued on all pads, the aggregate vmethod is called.
  *
  *  * One can peek at the data on any given GstAggregatorPad with the