From 758a6b3c061141af741c7dd777313f9d944ff86d Mon Sep 17 00:00:00 2001
From: Panagiotis Issaris <takis.issaris@uhasselt.be>
Date: Tue, 20 Feb 2007 10:34:01 +0000
Subject: [PATCH] Provide Doxygen documentation.
Originally committed as revision 8038 to svn://svn.ffmpeg.org/ffmpeg/trunk
---
libavcodec/allcodecs.c | 16 ++++++++++------
1 file changed, 10 insertions(+), 6 deletions(-)
diff --git a/libavcodec/allcodecs.c b/libavcodec/allcodecs.c
index 079120c7d6d..0a8f5292704 100644
--- a/libavcodec/allcodecs.c
+++ b/libavcodec/allcodecs.c
@@ -1,5 +1,5 @@
/*
- * Utils for libavcodec
+ * Provides registration of all codecs, parsers and bitstream filters for libavcodec.
* Copyright (c) 2002 Fabrice Bellard.
*
* This file is part of FFmpeg.
@@ -21,7 +21,7 @@
/**
* @file allcodecs.c
- * Utils for libavcodec.
+ * Provides registration of all codecs, parsers and bitstream filters for libavcodec.
*/
#include "avcodec.h"
@@ -35,11 +35,15 @@
#define REGISTER_PARSER(X,x) \
if(ENABLE_##X##_PARSER) av_register_codec_parser(&x##_parser)
-/* If you do not call this function, then you can select exactly which
- formats you want to support */
-
/**
- * simple call to register all the codecs.
+ * Register all the codecs, parsers and bitstream filters which were enabled at
+ * configuration time. If you do not call this function you can select exactly
+ * which formats you want to support, by using the individual registration
+ * functions.
+ *
+ * @see register_avcodec
+ * @see av_register_codec_parser
+ * @see av_register_bitstream_filter
*/
void avcodec_register_all(void)
{
--
GitLab