docs

include/evmmax/evmmax.hpp

@@ -7,6 +7,8 @@
 
 namespace evmmax
 {
+
+/// The modular arithmetic operations for EVMMAX (EVM Modular Arithmetic Extensions).
 template <typename UintT>
 class ModArith
 {
@@ -22,14 +24,19 @@ class ModArith
 public:
     explicit ModArith(const UintT& modulus) noexcept;
 
+    /// Converts a value to Montgomery form.
     uint to_mont(const uint& x) const noexcept;
 
+    /// Converts a value in Montgomery form back to normal value.
     uint from_mont(const uint& x) const noexcept;
 
+    /// Performs a Montgomery modular multiplication. Inputs must be in Montgomery form.
     uint mul(const uint& x, const uint& y) const noexcept;
 
+    /// Performs a modular addition.
     uint add(const uint& x, const uint& y) const noexcept;
 
+    /// Performs a modular subtraction.
     uint sub(const uint& x, const uint& y) const noexcept;
 };
 }  // namespace evmmax