[FFmpeg-cvslog] ffplay: extend doxy for audio_decode_frame()

[Stefano Sabatini]

ffmpeg | branch: master | Stefano Sabatini <stefasab at gmail.com> | Thu Jun 28 23:46:20 2012 +0200| [6032a1c977cc266cc49e1768024dfc87180dbea2] | committer: Stefano Sabatini

ffplay: extend doxy for audio_decode_frame()

> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=6032a1c977cc266cc49e1768024dfc87180dbea2
---

 ffplay.c |    8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/ffplay.c b/ffplay.c
index 93090ad..0f7b984 100644
--- a/ffplay.c
+++ b/ffplay.c
@@ -2066,7 +2066,13 @@ static int synchronize_audio(VideoState *is, int nb_samples)
     return wanted_nb_samples;
 }
 
-/* decode one audio frame and returns its uncompressed size */
+/**
+ * Decode one audio frame and return its uncompressed size.
+ *
+ * The processed audio frame is decoded, converted if required, and
+ * stored in is->audio_buf, with size in bytes given by the return
+ * value.
+ */
 static int audio_decode_frame(VideoState *is, double *pts_ptr)
 {
     AVPacket *pkt_temp = &is->audio_pkt_temp;