From 37725b03806205a96068f21aceb02600c70c8581 Mon Sep 17 00:00:00 2001 From: bing Date: Mon, 8 Jul 2024 21:15:45 +0800 Subject: [PATCH] docs: better doc comments --- src/encryption/symmetric/aes/mod.rs | 5 ++--- src/field/extension/mod.rs | 2 +- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/src/encryption/symmetric/aes/mod.rs b/src/encryption/symmetric/aes/mod.rs index 2b57f55..f27efbc 100644 --- a/src/encryption/symmetric/aes/mod.rs +++ b/src/encryption/symmetric/aes/mod.rs @@ -151,12 +151,11 @@ struct State([[u8; 4]; 4]); /// 2) The resulting polynomial is reduced modulo the following fixed polynomial: m(x) = x^8 + x^4 + /// x^3 + x + 1 /// -/// Note that you do not see this done here, this is implemented in [`AESFieldExtension`], within -/// the operation traits. +/// The above steps are implemented in [`AESFieldExtension`], within the operation traits. /// /// Note that in most AES implementations, this is done using "carry-less" multiplication - /// to see how this works in more concretely in field arithmetic, this implementation uses an actual -/// polynomial implementation (a [`Polynomial`] of [`BinaryField`]s). +/// polynomial implementation. fn galois_multiplication(mut col: u8, mut multiplicand: u8) -> u8 { // Decompose bits into degree-7 polynomials. let mut col_bits: [AESField; 8] = [AESField::ZERO; 8]; diff --git a/src/field/extension/mod.rs b/src/field/extension/mod.rs index 1dba586..583f1dc 100644 --- a/src/field/extension/mod.rs +++ b/src/field/extension/mod.rs @@ -22,7 +22,7 @@ pub type PlutoBaseFieldExtension = GaloisField<2, 101>; /// The [`AESFieldExtension`] is a specific instance of the [`GaloisField`] struct with the /// order set to the number `2^8`. This is the quadratic extension field over the -/// [`PlutoBaseField`] used in the Pluto `ronkathon` system. +/// [`AESField`][crate::field::prime::AESField] used in the Pluto `ronkathon` system. pub type AESFieldExtension = GaloisField<8, 2>; /// The [`PlutoScalarFieldExtension`] is a specific instance of the [`GaloisField`] struct with the