From 45ce17c49226e37e2b40e1b76a5e7e34ab36a6db Mon Sep 17 00:00:00 2001 From: Jeffrey Walton Date: Tue, 15 Dec 2020 03:58:05 -0500 Subject: [PATCH] Update documentation --- tweetnacl.h | 9 +++++++++ 1 file changed, 9 insertions(+) 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"