From caafb59af5e1d49d1949be002e94f4b44763263c Mon Sep 17 00:00:00 2001 From: Stefan Sauer Date: Sun, 17 Sep 2017 10:18:56 -0700 Subject: [PATCH] aggregator: documentaion fixes Fix typos and remove params docs, where the param was moved. --- libs/gst/base/gstaggregator.c | 2 +- libs/gst/base/gstaggregator.h | 7 +++---- 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/libs/gst/base/gstaggregator.c b/libs/gst/base/gstaggregator.c index 0e191a0deb..62762bbd7d 100644 --- a/libs/gst/base/gstaggregator.c +++ b/libs/gst/base/gstaggregator.c @@ -32,7 +32,7 @@ * * Base class for mixers and muxers. Subclasses should at least implement * the #GstAggregatorClass.aggregate() virtual method. * - * * When data is queued on all pads, tha aggregate vmethod is called. + * * When data is queued on all pads, the aggregate vmethod is called. * * * One can peek at the data on any given GstAggregatorPad with the * gst_aggregator_pad_get_buffer () method, and take ownership of it diff --git a/libs/gst/base/gstaggregator.h b/libs/gst/base/gstaggregator.h index 0fb918d04f..ba65035a96 100644 --- a/libs/gst/base/gstaggregator.h +++ b/libs/gst/base/gstaggregator.h @@ -60,7 +60,6 @@ typedef struct _GstAggregatorPadPrivate GstAggregatorPadPrivate; /** * GstAggregatorPad: - * @buffer: currently queued buffer. * @segment: last segment received. * * The implementation the GstPad to use with #GstAggregator @@ -157,7 +156,7 @@ struct _GstAggregator * The type of the pads that should be created when * GstElement.request_new_pad is called. * @flush: Optional. - * Called after a succesful flushing seek, once all the flush + * Called after a successful flushing seek, once all the flush * stops have been received. Flush pad-specific data in * #GstAggregatorPad->flush. * @clip: Optional. @@ -165,7 +164,7 @@ struct _GstAggregator * clipping it and translating it to the current segment falls * on the subclass. The function should use the segment of data * and the negotiated media type on the pad to perform - * clipping of inbuffer. This function takes ownership of + * clipping of input buffer. This function takes ownership of * buf and should output a buffer or return NULL in * if the buffer should be dropped. * @sink_event: Optional. @@ -228,7 +227,7 @@ struct _GstAggregator * * It will also take care of event ordering (stream-start, segment, eos). * - * Basically, a basic implementation will override @aggregate, and call + * Basically, a simple implementation will override @aggregate, and call * _finish_buffer from inside that function. */ struct _GstAggregatorClass {