sha3.c: compress algorithm list in header comment block, mark entire file as INTERNAL to doxygen

1 files changed, 12 insertions, 19 deletions

diff --git a/sha3.c b/sha3.c
index 526574d..073ee83 100644
--- a/sha3.c
+++ b/sha3.c
@@ -7,25 +7,14 @@
  *
  * C11 implementations of the following SHA-3 algorithms:
  *
- * - SHA3-224
- * - SHA3-256
- * - SHA3-384
- * - SHA3-512
- * - HMAC-SHA3-224
- * - HMAC-SHA3-256
- * - HMAC-SHA3-384
- * - HMAC-SHA3-512
- * - SHAKE128 and SHAKE128-XOF
- * - SHAKE256 and SHAKE256-XOF
- * - cSHAKE128 and cSHAKE128-XOF
- * - cSHAKE256 and cSHAKE256-XOF
- * - KMAC128 and KMAC128-XOF
- * - KMAC256 and KMAC256-XOF
- * - TupleHash128 and TupleHash128-XOF
- * - TupleHash256 and TupleHash256-XOF
- * - ParallelHash128 and ParallelHash128-XOF
- * - ParallelHash256 and ParallelHash256-XOF
- * - TurboSHAKE128 and TurboSHAKE256
+ * - SHA3-224, SHA3-256, SHA3-384, SHA3-512
+ * - HMAC-SHA3-224, HMAC-SHA3-256, HMAC-SHA3-384, HMAC-SHA3-512
+ * - SHAKE128, SHAKE128-XOF, SHAKE256, SHAKE256-XOF
+ * - cSHAKE128, cSHAKE128-XOF, cSHAKE256, cSHAKE256-XOF
+ * - KMAC128, KMAC128-XOF, KMAC256, KMAC256-XOF
+ * - TupleHash128, TupleHash128-XOF, TupleHash256, TupleHash256-XOF
+ * - ParallelHash128, ParallelHash128-XOF, ParallelHash256, ParallelHash256-XOF
+ * - TurboSHAKE128, TurboSHAKE256
  * - KangarooTwelve
  */
 
@@ -34,6 +23,8 @@
 #include <string.h> // memcpy()
 #include "sha3.h"
 
+/** @cond INTERNAL */
+
 // 64-bit rotate left
 #define ROL(v, n) (((v) << (n)) | ((v) >> (64-(n))))
 
@@ -7057,3 +7048,5 @@ int main(void) {
 }
 
 #endif /* SHA3_TEST */
+
+/** @endcond INTERNAL */