audioencoder: api doc fixes.
authorStefan Sauer <ensonic@users.sf.net>
Mon, 25 Mar 2013 15:46:29 +0000 (16:46 +0100)
committerStefan Sauer <ensonic@users.sf.net>
Fri, 29 Mar 2013 09:33:35 +0000 (10:33 +0100)
gst-libs/gst/audio/gstaudioencoder.c

index c96d665..66795ca 100644 (file)
  *     </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,
  *   </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>
  *