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

Timothy Gu timothygu99 at gmail.com
Sat Nov 2 23:03:21 CET 2013


Signed-off-by: Timothy Gu <timothygu99 at gmail.com>
---
 libavutil/des.c |  8 ++++++++
 libavutil/des.h | 13 +++++++++++++
 2 files changed, 21 insertions(+)

diff --git a/libavutil/des.c b/libavutil/des.c
index 57ad0a4..b9c6b73 100644
--- a/libavutil/des.c
+++ b/libavutil/des.c
@@ -18,6 +18,14 @@
  * 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 DES encryptor/decryptor
+ * @author Reimar Doeffinger
+ * @ingroup lavu_des
+ */
+
 #include <inttypes.h>
 #include "avutil.h"
 #include "common.h"
diff --git a/libavutil/des.h b/libavutil/des.h
index 2feb046..66a252d 100644
--- a/libavutil/des.h
+++ b/libavutil/des.h
@@ -19,6 +19,15 @@
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
+/**
+ * @file
+ * Public header for libavutil DES encryptor/decryptor
+ * @author Reimar Doeffinger
+ * @defgroup lavu_des DES
+ * @ingroup lavu_crypto
+ * @{
+ */
+
 #ifndef AVUTIL_DES_H
 #define AVUTIL_DES_H
 
@@ -58,4 +67,8 @@ void av_des_crypt(struct AVDES *d, uint8_t *dst, const uint8_t *src, int count,
  */
 void av_des_mac(struct AVDES *d, uint8_t *dst, const uint8_t *src, int count);
 
+/**
+ * @}
+ */
+
 #endif /* AVUTIL_DES_H */
-- 
1.8.1.2



More information about the ffmpeg-devel mailing list