[FFmpeg-cvslog] r23801 - in branches/0.6: . libavformat/avformat.h

[siretart]

Author: siretart
Date: Sat Jun 26 17:32:27 2010
New Revision: 23801

Log:
Doxygen av_codec_get_id() and av_codec_get_tag().

backport r23102 by stefano

Modified:
   branches/0.6/   (props changed)
   branches/0.6/libavformat/avformat.h

Modified: branches/0.6/libavformat/avformat.h
==============================================================================
--- branches/0.6/libavformat/avformat.h	Sat Jun 26 17:29:53 2010	(r23800)
+++ branches/0.6/libavformat/avformat.h	Sat Jun 26 17:32:27 2010	(r23801)
@@ -869,8 +869,22 @@ void av_pkt_dump_log(void *avcl, int lev
  */
 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 */