[FFmpeg-cvslog] lavf doxy: expand AVStream.codec doxy.

[Anton Khirnov]

ffmpeg | branch: master | Anton Khirnov <anton at khirnov.net> | Thu Mar 15 11:27:47 2012 +0100| [967923abd15b58a0029c36e5a0be7de108b0deb7] | committer: Anton Khirnov

lavf doxy: expand AVStream.codec doxy.

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

 libavformat/avformat.h |   13 ++++++++++++-
 1 files changed, 12 insertions(+), 1 deletions(-)

diff --git a/libavformat/avformat.h b/libavformat/avformat.h
index 98cfee1..cd7ece8 100644
--- a/libavformat/avformat.h
+++ b/libavformat/avformat.h
@@ -610,7 +610,18 @@ typedef struct AVStream {
      * encoding: set by the user
      */
     int id;
-    AVCodecContext *codec; /**< codec context */
+    /**
+     * Codec context associated with this stream. Allocated and freed by
+     * libavformat.
+     *
+     * - decoding: The demuxer exports codec information stored in the headers
+     *             here.
+     * - encoding: The user sets codec information, the muxer writes it to the
+     *             output. Mandatory fields as specified in AVCodecContext
+     *             documentation must be set even if this AVCodecContext is
+     *             not actually used for encoding.
+     */
+    AVCodecContext *codec;
     /**
      * Real base framerate of the stream.
      * This is the lowest framerate with which all timestamps can be