Various small fixes

src/lib/pubkey/classic_mceliece/cmce_encaps.h

@@ -23,8 +23,7 @@
 namespace Botan {
 
 /**
- * @brief Classic McEliece Encapsulation Operation
-
+ * Classic McEliece Encapsulation Operation
  */
 class BOTAN_TEST_API Classic_McEliece_Encryptor final : public PK_Ops::KEM_Encryption {
    public:
@@ -49,11 +48,6 @@ class BOTAN_TEST_API Classic_McEliece_Encryptor final : public PK_Ops::KEM_Encry
 
       /**
        * @brief Encodes an error vector by multiplying it with the Classic McEliece matrix.
-       *
-       * @param params
-       * @param e
-       * @param mat
-       * @return bitvector
        */
       bitvector encode(const Classic_McEliece_Parameters& params,
                        const secure_bitvector& e,

src/lib/pubkey/classic_mceliece/cmce_gf.h

@@ -56,12 +56,8 @@ class BOTAN_TEST_API Classic_McEliece_GF {
       static size_t log_q_from_mod(uint16_t modulus) { return high_bit(modulus) - 1; }
 
       /**
-       * @brief Get m.
+       * @brief Get m, the degree of the element's modulus.
        *
-       * For a given irreducible polynomial @p modulus f(z) representing the modulus of a finite field GF(q) = GF(2^m),
-       * get the degree log_q of f(z) which corresponds to m.
-       *
-       * @param modulus The modulus of GF(q).
        * @return size_t The degree log_q of the modulus (m for GF(2^m)).
        */
       size_t log_q() const { return log_q_from_mod(m_modulus); }
@@ -81,25 +77,25 @@ class BOTAN_TEST_API Classic_McEliece_GF {
       uint16_t modulus() const { return m_modulus; }
 
       /**
-       * @brief Change the element to @param elem.
+       * @brief Change the element to @p elem.
        */
       Classic_McEliece_GF& operator=(const uint16_t elem) {
          m_elem = elem & ((size_t(1) << log_q()) - 1);
          return *this;
       }
 
       /**
-       * @brief Divide the element by @param other in GF(q). Constant time.
+       * @brief Divide the element by @p other in GF(q). Constant time.
        */
       Classic_McEliece_GF operator/(const Classic_McEliece_GF& other) const;
 
       /**
-       * @brief Add @param other to the element. Constant time.
+       * @brief Add @p other to the element. Constant time.
        */
       Classic_McEliece_GF operator+(const Classic_McEliece_GF& other) const;
 
       /**
-       * @brief Add @param other to the element. Constant time.
+       * @brief Add @p other to the element. Constant time.
        */
       Classic_McEliece_GF& operator+=(const Classic_McEliece_GF& other);
 
@@ -109,17 +105,17 @@ class BOTAN_TEST_API Classic_McEliece_GF {
       Classic_McEliece_GF& operator^=(uint16_t other);
 
       /**
-       * @brief Multiply the element by @param other in GF(q). Constant time.
+       * @brief Multiply the element by @p other in GF(q). Constant time.
        */
       Classic_McEliece_GF& operator*=(const Classic_McEliece_GF& other);
 
       /**
-       * @brief Multiply the element by @param other in GF(q). Constant time.
+       * @brief Multiply the element by @p other in GF(q). Constant time.
        */
       Classic_McEliece_GF operator*(const Classic_McEliece_GF& other) const;
 
       /**
-       * @brief Check if the element is equal to @param other. Modulus is ignored.
+       * @brief Check if the element is equal to @p other. Modulus is ignored.
        */
       bool operator==(const Classic_McEliece_GF& other) const { return elem() == other.elem(); }
 

src/lib/pubkey/classic_mceliece/cmce_keys_internal.h

@@ -111,7 +111,7 @@ class BOTAN_TEST_API Classic_McEliece_PrivateKeyInternal {
       /**
        * @brief Parses a Classic McEliece private key from a byte sequence.
        *
-       * It also creates the field ordering from the control bits in @param sk_bytes.
+       * It also creates the field ordering from the control bits in @p sk_bytes.
        *
        * @param params The Classic McEliece parameters
        * @param sk_bytes The secret key byte sequence

src/tests/test_cmce.cpp

@@ -11,20 +11,22 @@
 #include "test_rng.h"
 #include "tests.h"
 
-#include <botan/cmce.h>
-#include <botan/hash.h>
-#include <botan/pk_algs.h>
-#include <botan/pubkey.h>
-#include <botan/internal/cmce_debug_utils.h>
-#include <botan/internal/cmce_decaps.h>
-#include <botan/internal/cmce_encaps.h>
-#include <botan/internal/cmce_field_ordering.h>
-#include <botan/internal/cmce_gf.h>
-#include <botan/internal/cmce_keys_internal.h>
-#include <botan/internal/cmce_parameters.h>
-#include <botan/internal/cmce_poly.h>
-
-#include <iostream>
+#if defined(BOTAN_HAS_CLASSICMCELIECE)
+
+   #include <botan/cmce.h>
+   #include <botan/hash.h>
+   #include <botan/pk_algs.h>
+   #include <botan/pubkey.h>
+   #include <botan/internal/cmce_debug_utils.h>
+   #include <botan/internal/cmce_decaps.h>
+   #include <botan/internal/cmce_encaps.h>
+   #include <botan/internal/cmce_field_ordering.h>
+   #include <botan/internal/cmce_gf.h>
+   #include <botan/internal/cmce_keys_internal.h>
+   #include <botan/internal/cmce_parameters.h>
+   #include <botan/internal/cmce_poly.h>
+
+   #include <iostream>
 
 namespace Botan_Tests {
 
@@ -302,7 +304,7 @@ class CMCE_Invalid_Test : public Text_Based_Test {
       }
 };
 
-#if false
+   #if false
 class CMCE_Decaps_Unit_Test final : public Text_Based_Test {
    private:
       std::vector<Botan::Classic_McEliece_GF> gf_vector_from_bytes(const Botan::Classic_McEliece_Parameters& params,
@@ -381,7 +383,7 @@ class CMCE_Decaps_Unit_Test final : public Text_Based_Test {
          return result;
       }
 };
-#endif
+   #endif
 
 class CMCE_Generic_Keygen_Tests final : public PK_Key_Generation_Test {
    public:
@@ -482,3 +484,5 @@ BOTAN_REGISTER_TEST("cmce", "cmce_invalid", CMCE_Invalid_Test);
 BOTAN_REGISTER_TEST("cmce", "cmce_minimal", CMCE_Minimal_Test);
 
 }  // namespace Botan_Tests
+
+#endif  // BOTAN_HAS_CLASSICMCELIECE