Doxygen av_codec_get_id() and av_codec_get_tag().

backport r23102 by stefano


Originally committed as revision 23801 to svn://svn.ffmpeg.org/ffmpeg/branches/0.6

1 files changed, 15 insertions, 1 deletions

diff --git a/libavformat/avformat.h b/libavformat/avformat.h
index 0e93376bdb..dbd22bb80d 100644
--- a/libavformat/avformat.h
+++ b/libavformat/avformat.h
@@ -869,8 +869,22 @@ void av_pkt_dump_log(void *avcl, int level, AVPacket *pkt, int dump_payload);
  */
 void av_register_all(void);
 
-/** codec tag <-> codec id */
+/**
+ * Gets the CodecID for the given codec tag tag.
+ * If no codec id is found returns CODEC_ID_NONE.
+ *
+ * @param tags list of supported codec_id-codec_tag pairs, as stored
+ * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
+ */
 enum CodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag);
+
+/**
+ * Gets the codec tag for the given codec id id.
+ * If no codec tag is found returns 0.
+ *
+ * @param tags list of supported codec_id-codec_tag pairs, as stored
+ * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag
+ */
 unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum CodecID id);
 
 /* media file input */