doc: add the rustdoc clippy is asking for

Author: huitseeker

blake2/src/lib.rs

@@ -35,6 +35,7 @@ use digest::zeroize::{Zeroize, ZeroizeOnDrop};
 mod as_bytes;
 mod consts;
 
+/// SIMD vector operations and types for Blake2 compression function.
 pub mod simd;
 
 #[macro_use]

blake2/src/macros.rs

@@ -7,9 +7,12 @@ macro_rules! blake2_impl {
         #[derive(Clone)]
         #[doc=$vardoc]
         pub struct $name {
+            /// Blake2 state vector (8 words total, stored as 2 SIMD vectors).
             pub h: [$vec; 2],
+            /// Total number of bytes processed so far.
             pub t: u64,
             #[cfg(feature = "reset")]
+            /// Initial state vector for reset functionality.
             pub h0: [$vec; 2],
         }
 

blake2/src/simd.rs

@@ -12,29 +12,41 @@ mod simdty;
 
 pub use self::simdty::{u32x4, u64x4};
 
+/// SIMD vector operations for 4-element vectors used in Blake2 compression.
 pub trait Vector4<T>: Copy {
+    /// Gather elements from a slice at specified indices into a 4-element vector.
     fn gather(src: &[T], i0: usize, i1: usize, i2: usize, i3: usize) -> Self;
 
+    /// Convert from little-endian byte order (no-op on little-endian targets).
     #[allow(clippy::wrong_self_convention)]
     fn from_le(self) -> Self;
+    /// Convert to little-endian byte order (no-op on little-endian targets).
     fn to_le(self) -> Self;
 
+    /// Wrapping addition of two vectors.
     fn wrapping_add(self, rhs: Self) -> Self;
 
+    /// Rotate all elements right by a constant number of bits.
     fn rotate_right_const(self, n: u32) -> Self;
 
+    /// Shuffle elements left by 1 position: \[a,b,c,d\] -> \[b,c,d,a\].
     fn shuffle_left_1(self) -> Self;
+    /// Shuffle elements left by 2 positions: \[a,b,c,d\] -> \[c,d,a,b\].
     fn shuffle_left_2(self) -> Self;
+    /// Shuffle elements left by 3 positions: \[a,b,c,d\] -> \[d,a,b,c\].
     fn shuffle_left_3(self) -> Self;
 
+    /// Shuffle elements right by 1 position: \[a,b,c,d\] -> \[d,a,b,c\].
     #[inline(always)]
     fn shuffle_right_1(self) -> Self {
         self.shuffle_left_3()
     }
+    /// Shuffle elements right by 2 positions: \[a,b,c,d\] -> \[c,d,a,b\].
     #[inline(always)]
     fn shuffle_right_2(self) -> Self {
         self.shuffle_left_2()
     }
+    /// Shuffle elements right by 3 positions: \[a,b,c,d\] -> \[b,c,d,a\].
     #[inline(always)]
     fn shuffle_right_3(self) -> Self {
         self.shuffle_left_1()

blake2/src/simd/simdty.rs

@@ -73,7 +73,9 @@ impl<T: Eq> Eq for Simd4<T> {}
 
 pub type u64x2 = Simd2<u64>;
 
+/// SIMD vector of four 32-bit unsigned integers.
 pub type u32x4 = Simd4<u32>;
+/// SIMD vector of four 64-bit unsigned integers.
 pub type u64x4 = Simd4<u64>;
 
 pub type u16x8 = Simd8<u16>;