[FFmpeg-devel] [PATCH 15/17] avutil/sha(512): add Doxy @file and group

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


Signed-off-by: Timothy Gu <timothygu99 at gmail.com>
---
 libavutil/sha.c    | 10 ++++++++++
 libavutil/sha.h    |  4 +++-
 libavutil/sha512.c |  9 +++++++++
 libavutil/sha512.h |  4 +++-
 4 files changed, 25 insertions(+), 2 deletions(-)

diff --git a/libavutil/sha.c b/libavutil/sha.c
index 0cf9424..3e090d6 100644
--- a/libavutil/sha.c
+++ b/libavutil/sha.c
@@ -21,6 +21,16 @@
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
+/**
+ * @file
+ * @brief SHA-1/160/224/256 hasher
+ * @author Michael Niedermayer, Konstantin Shishkov, Steve Reid, and Aaron D. Gifford
+ *
+ * Based on public domain SHA-1 code by Steve Reid <steve at edmweb.com>
+ * and on BSD-licensed SHA-2 code by Aaron D. Gifford
+ * @ingroup lavu_sha
+ */
+
 #include <string.h>
 
 #include "attributes.h"
diff --git a/libavutil/sha.h b/libavutil/sha.h
index bf4377e..c4a3e27 100644
--- a/libavutil/sha.h
+++ b/libavutil/sha.h
@@ -27,7 +27,9 @@
 #include "version.h"
 
 /**
- * @defgroup lavu_sha SHA
+ * @file
+ * Public header for libavutil SHA-1/160/224/256 hasher
+ * @defgroup lavu_sha SHA-1/160/224/256
  * @ingroup lavu_crypto
  * @{
  */
diff --git a/libavutil/sha512.c b/libavutil/sha512.c
index 66a864f..6e596bf 100644
--- a/libavutil/sha512.c
+++ b/libavutil/sha512.c
@@ -21,6 +21,15 @@
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
+/**
+ * @file
+ * @brief SHA-512 hasher
+ * @author Michael Niedermayer, Konstantin Shishkov, James Almer, and Aaron D. Gifford
+ *
+ * Based on  BSD-licensed SHA-2 code by Aaron D. Gifford
+ * @ingroup lavu_sha512
+ */
+
 #include <string.h>
 
 #include "attributes.h"
diff --git a/libavutil/sha512.h b/libavutil/sha512.h
index 7b08701..d36c1ab 100644
--- a/libavutil/sha512.h
+++ b/libavutil/sha512.h
@@ -28,7 +28,9 @@
 #include "version.h"
 
 /**
- * @defgroup lavu_sha512 SHA512
+ * @file
+ * Public header for libavutil SHA-512 hasher
+ * @defgroup lavu_sha512 SHA-512
  * @ingroup lavu_crypto
  * @{
  */
-- 
1.8.1.2



More information about the ffmpeg-devel mailing list