[FFmpeg-devel] [PATCH 13/17] avutil/rc4: add Doxy @file and group

[Timothy Gu]

Signed-off-by: Timothy Gu <timothygu99 at gmail.com>
---
 libavutil/rc4.c | 10 ++++++++++
 libavutil/rc4.h | 12 ++++++++++++
 2 files changed, 22 insertions(+)

diff --git a/libavutil/rc4.c b/libavutil/rc4.c
index 4e52ba5..9d582e2 100644
--- a/libavutil/rc4.c
+++ b/libavutil/rc4.c
@@ -20,6 +20,16 @@
  * License along with FFmpeg; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
+
+/**
+ * @file
+ * @brief RC4 encryption/decryption/pseudo-random number generator
+ * Loosely based on LibTomCrypt by Tom St. Denis
+ *
+ * @author Reimar Doeffinger
+ * @ingroup lavu_rc4
+ */
+
 #include "avutil.h"
 #include "common.h"
 #include "rc4.h"
diff --git a/libavutil/rc4.h b/libavutil/rc4.h
index 9362fd8..f84b23b 100644
--- a/libavutil/rc4.h
+++ b/libavutil/rc4.h
@@ -23,6 +23,14 @@
 
 #include <stdint.h>
 
+/**
+ * @file
+ * Public header for libavutil RC4 implementation
+ * @defgroup lavu_rc4 RC4
+ * @ingroup lavu_crypto
+ * @{
+ */
+
 struct AVRC4 {
     uint8_t state[256];
     int x, y;
@@ -47,4 +55,8 @@ int av_rc4_init(struct AVRC4 *d, const uint8_t *key, int key_bits, int decrypt);
  */
 void av_rc4_crypt(struct AVRC4 *d, uint8_t *dst, const uint8_t *src, int count, uint8_t *iv, int decrypt);
 
+/**
+ * @}
+ */
+
 #endif /* AVUTIL_RC4_H */
-- 
1.8.1.2