summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStefan Sauer <ensonic@users.sf.net>2013-03-25 16:46:29 +0100
committerStefan Sauer <ensonic@users.sf.net>2013-03-29 10:33:35 +0100
commite4ee1dde02770ffc1cf3b51bd7e6c461eddef51d (patch)
treee022916ef5b26889efbdb8610ac02ecea7d924ce
parent701ae2f144820c3f2ddaef959938daa8a4b89609 (diff)
audioencoder: api doc fixes.
-rw-r--r--gst-libs/gst/audio/gstaudioencoder.c9
1 files changed, 5 insertions, 4 deletions
diff --git a/gst-libs/gst/audio/gstaudioencoder.c b/gst-libs/gst/audio/gstaudioencoder.c
index c96d665aa..66795ca85 100644
--- a/gst-libs/gst/audio/gstaudioencoder.c
+++ b/gst-libs/gst/audio/gstaudioencoder.c
@@ -62,9 +62,10 @@
* </para></listitem>
* <listitem><para>
* If codec processing results in encoded data, subclass should call
- * @gst_audio_encoder_finish_frame to have encoded data pushed
- * downstream. Alternatively, it might also call to indicate dropped
- * (non-encoded) samples.
+ * gst_audio_encoder_finish_frame() to have encoded data pushed
+ * downstream. Alternatively, it might also call
+ * gst_audio_encoder_finish_frame() (with a NULL buffer and some number of
+ * dropped samples) to indicate dropped (non-encoded) samples.
* </para></listitem>
* <listitem><para>
* Just prior to actually pushing a buffer downstream,
@@ -140,7 +141,7 @@
* </para></listitem>
* <listitem><para>
* Accept data in @handle_frame and provide encoded results to
- * @gst_audio_encoder_finish_frame.
+ * gst_audio_encoder_finish_frame().
* </para></listitem>
* </itemizedlist>
*