summaryrefslogtreecommitdiff
path: root/tweetnacl.h
diff options
context:
space:
mode:
authorJeffrey Walton <noloader@gmail.com>2020-12-15 03:58:05 -0500
committerJeffrey Walton <noloader@gmail.com>2020-12-15 03:58:05 -0500
commit45ce17c49226e37e2b40e1b76a5e7e34ab36a6db (patch)
treef59ff36052537aef9adaaaea844fea4bfc93806d /tweetnacl.h
parentfe4f9a0748e2d7250bbf4ccc5bf386035208b0a8 (diff)
downloadcryptopp-git-45ce17c49226e37e2b40e1b76a5e7e34ab36a6db.tar.gz
Update documentation
Diffstat (limited to 'tweetnacl.h')
-rw-r--r--tweetnacl.h9
1 files changed, 9 insertions, 0 deletions
diff --git a/tweetnacl.h b/tweetnacl.h
index 3c097281..635beafc 100644
--- a/tweetnacl.h
+++ b/tweetnacl.h
@@ -1,3 +1,12 @@
+// tweetnacl.h - written and placed in the public domain by Jeffrey Walton
+
+/// \file nr.h
+/// \brief Declarations for Bernstein's TweetNaCL
+/// \details TweetNaCL is used to cross-validate the library's implementations.
+/// The implementation itself is not optimized and kind of amusing. However
+/// it serves a valuable purpose for cross-validation.
+/// \details Don't use this in production.
+
#ifndef TWEETNACL_H
#define TWEETNACL_H
#define crypto_auth_PRIMITIVE "hmacsha512256"