Further overhaul of package line comments.

core/crypto/aead/doc.odin

@@ -1,6 +1,5 @@
-
 /*
-package aead implements a generic interface to Authenticated Encryption with Associated Data algorithms.
+A generic interface to Authenticated Encryption with Associated Data (`AEAD`) algorithms.
 
 Both a one-shot and context based interface are provided, with similar
 usage.  If multiple messages are to be sealed/opened via the same key,

core/crypto/aegis/aegis.odin

@@ -1,5 +1,5 @@
 /*
-package aegis implements the AEGIS-128L and AEGIS-256 AEAD algorithms.
+`AEGIS-128L` and `AEGIS-256` AEAD algorithms.
 
 Where AEAD stands for Authenticated Encryption with Additional Data.
 

core/crypto/aes/aes.odin

@@ -1,5 +1,5 @@
 /*
-package aes implements the AES block cipher and some common modes.
+The `AES` block cipher and some common modes.
 
 See:
 - [[ https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.197-upd1.pdf ]]

core/crypto/blake2b/blake2b.odin

@@ -1,5 +1,5 @@
 /*
-package blake2b implements the BLAKE2b hash algorithm.
+`BLAKE2b` hash algorithm.
 
 See:
 - [[ https://datatracker.ietf.org/doc/html/rfc7693 ]]

core/crypto/blake2s/blake2s.odin

@@ -1,5 +1,5 @@
 /*
-package blake2s implements the BLAKE2s hash algorithm.
+`BLAKE2s` hash algorithm.
 
 See:
 - [[ https://datatracker.ietf.org/doc/html/rfc7693 ]]

core/crypto/chacha20/chacha20.odin

@@ -1,5 +1,5 @@
 /*
-package chacha20 implements the ChaCha20 and XChaCha20 stream ciphers.
+`ChaCha20` and `XChaCha20` stream ciphers.
 
 See:
 - [[ https://datatracker.ietf.org/doc/html/rfc8439 ]]

core/crypto/chacha20poly1305/chacha20poly1305.odin

@@ -1,5 +1,5 @@
 /*
-package chacha20poly1305 implements the CHACHA20_POLY1305 and XChaCha20_Poly1305 AEAD algorithms.
+`AEAD_CHACHA20_POLY1305` and `AEAD_XChaCha20_Poly1305` algorithms.
 
 Where AEAD stands for Authenticated Encryption with Additional Data.
 

core/crypto/crypto.odin

@@ -1,4 +1,4 @@
-// package crypto implements a selection of cryptography algorithms and useful helper routines.
+// A selection of cryptography algorithms and useful helper routines.
 package crypto
 
 import "base:runtime"

core/crypto/deoxysii/deoxysii.odin

@@ -1,5 +1,5 @@
 /*
-package deoxysii implements the Deoxys-II-256 Authenticated Encryption with Additional Data algorithm.
+`Deoxys-II-256` Authenticated Encryption with Additional Data (`AEAD`) algorithm.
 
 - [[ https://sites.google.com/view/deoxyscipher ]]
 - [[ https://thomaspeyrin.github.io/web/assets/docs/papers/Jean-etal-JoC2021.pdf ]]

core/crypto/ed25519/ed25519.odin

@@ -1,5 +1,5 @@
 /*
-package ed25519 implements the Ed25519 EdDSA signature algorithm.
+`Ed25519` EdDSA signature algorithm.
 
 See:
 - [[ https://datatracker.ietf.org/doc/html/rfc8032 ]]

core/crypto/hash/doc.odin

@@ -1,5 +1,5 @@
 /*
-package hash provides a generic interface to the supported hash algorithms.
+A generic interface to the supported hash algorithms.
 
 A high-level convenience procedure group `hash` is provided to easily
 accomplish common tasks.

core/crypto/hkdf/hkdf.odin

@@ -1,5 +1,5 @@
 /*
-package hkdf implements the HKDF HMAC-based Extract-and-Expand Key Derivation Function.
+`HKDF` HMAC-based Extract-and-Expand Key Derivation Function.
 
 See: [[ https://www.rfc-editor.org/rfc/rfc5869 ]]
 */

core/crypto/hmac/hmac.odin

@@ -1,5 +1,5 @@
 /*
-package hmac implements the HMAC MAC algorithm.
+`HMAC` message authentication code (`MAC`) algorithm.
 
 See:
 - [[ https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.198-1.pdf ]]

core/crypto/kmac/kmac.odin

@@ -1,5 +1,5 @@
 /*
-package kmac implements the KMAC MAC algorithm.
+`KMAC` message authentication code (`MAC`) algorithm.
 
 See:
 - [[ https://nvlpubs.nist.gov/nistpubs/specialpublications/nist.sp.800-185.pdf ]]

core/crypto/legacy/keccak/keccak.odin

@@ -1,5 +1,5 @@
 /*
-package keccak implements the Keccak hash algorithm family.
+`Keccak` hash algorithm family.
 
 During the SHA-3 standardization process, the padding scheme was changed
 thus Keccac and SHA-3 produce different outputs.  Most users should use

core/crypto/legacy/md5/md5.odin

@@ -1,5 +1,5 @@
 /*
-package md5 implements the MD5 hash algorithm.
+`MD5` hash algorithm.
 
 WARNING: The MD5 algorithm is known to be insecure and should only be
 used for interoperating with legacy applications.

core/crypto/legacy/sha1/sha1.odin

@@ -1,5 +1,5 @@
 /*
-package sha1 implements the SHA1 hash algorithm.
+`SHA1` hash algorithm.
 
 WARNING: The SHA1 algorithm is known to be insecure and should only be
 used for interoperating with legacy applications.

core/crypto/pbkdf2/pbkdf2.odin

@@ -1,5 +1,5 @@
 /*
-package pbkdf2 implements the PBKDF2 password-based key derivation function.
+`PBKDF2` password-based key derivation function.
 
 See: [[ https://www.rfc-editor.org/rfc/rfc2898 ]]
 */

core/crypto/poly1305/poly1305.odin

@@ -1,5 +1,5 @@
 /*
-package poly1305 implements the Poly1305 one-time MAC algorithm.
+`Poly1305` one-time MAC algorithm.
 
 See:
 - [[ https://datatracker.ietf.org/doc/html/rfc8439 ]]

core/crypto/ristretto255/ristretto255.odin

@@ -1,5 +1,5 @@
 /*
-package ristretto255 implement the ristretto255 prime-order group.
+Ristretto255 prime-order group.
 
 See:
 - [[ https://www.rfc-editor.org/rfc/rfc9496 ]]

core/crypto/sha2/sha2.odin

@@ -1,5 +1,5 @@
 /*
-package sha2 implements the SHA2 hash algorithm family.
+`SHA2` hash algorithm family.
 
 See:
 - [[ https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.180-4.pdf ]]

core/crypto/sha3/sha3.odin

@@ -1,5 +1,5 @@
 /*
-package sha3 implements the SHA3 hash algorithm family.
+`SHA3` hash algorithm family.
 
 The SHAKE XOF can be found in crypto/shake.  While discouraged if the
 pre-standardization Keccak algorithm is required, it can be found in

core/crypto/shake/shake.odin

@@ -1,5 +1,5 @@
 /*
-package shake implements the SHAKE and cSHAKE XOF algorithm families.
+`SHAKE` and `cSHAKE` XOF algorithm families.
 
 The SHA3 hash algorithm can be found in the crypto/sha3.
 

core/crypto/siphash/siphash.odin

@@ -1,5 +1,5 @@
 /*
-package siphash Implements the SipHash hashing algorithm.
+`SipHash` hashing algorithm.
 
 Use the specific procedures for a certain setup. The generic procedures will default to Siphash 2-4.
 

core/crypto/sm3/sm3.odin

@@ -1,5 +1,5 @@
 /*
-package sm3 implements the SM3 hash algorithm.
+`SM3` hash algorithm.
 
 See:
 - [[ https://datatracker.ietf.org/doc/html/draft-sca-cfrg-sm3-02 ]]

core/crypto/tuplehash/tuplehash.odin

@@ -1,5 +1,5 @@
 /*
-package tuplehash implements the TupleHash and TupleHashXOF algorithms.
+`TupleHash` and `TupleHashXOF` algorithms.
 
 See:
 - [[ https://nvlpubs.nist.gov/nistpubs/specialpublications/nist.sp.800-185.pdf ]]

core/crypto/x25519/x25519.odin

@@ -1,5 +1,5 @@
 /*
-package x25519 implements the X25519 (aka curve25519) Elliptic-Curve Diffie-Hellman key exchange protocol.
+`X25519` (aka `curve25519`) Elliptic-Curve Diffie-Hellman key exchange protocol.
 
 See:
 - [[ https://www.rfc-editor.org/rfc/rfc7748 ]]

core/crypto/x448/x448.odin

@@ -1,5 +1,5 @@
 /*
-package x448 implements the X448 (aka curve448) Elliptic-Curve Diffie-Hellman key exchange protocol.
+`X448` (aka `curve448`) Elliptic-Curve Diffie-Hellman key exchange protocol.
 
 See:
 - [[ https://www.rfc-editor.org/rfc/rfc7748 ]]