aboutsummaryrefslogtreecommitdiffstats
path: root/src/lib
diff options
context:
space:
mode:
authorJack Lloyd <[email protected]>2018-03-28 03:57:43 -0400
committerJack Lloyd <[email protected]>2018-03-28 05:13:37 -0400
commitcda33965bcf2ea73c4157ed97c3745ac027fd7c4 (patch)
treefc4c16416917e045c1ed4fdf7b35bff6bb0d5531 /src/lib
parent5b7cb0d19d7ffe97712c39aaf2f861a2504442aa (diff)
Fix some Doxygen errors
Diffstat (limited to 'src/lib')
-rw-r--r--src/lib/math/bigint/bigint.h3
-rw-r--r--src/lib/math/mp/mp_core.h1
-rw-r--r--src/lib/misc/fpe_fe1/fpe_fe1.h2
-rw-r--r--src/lib/pubkey/ec_group/point_gfp.h12
4 files changed, 17 insertions, 1 deletions
diff --git a/src/lib/math/bigint/bigint.h b/src/lib/math/bigint/bigint.h
index 3d6626e4d..cb518e727 100644
--- a/src/lib/math/bigint/bigint.h
+++ b/src/lib/math/bigint/bigint.h
@@ -253,7 +253,8 @@ class BOTAN_PUBLIC_API(2,0) BigInt final
/**
* Set *this to y - *this
- * @param y the BigInt to subtract from
+ * @param y the BigInt to subtract from as a sequence of words
+ * @param y_size length of y in words
* @param ws a temp workspace
*/
BigInt& rev_sub(const word y[], size_t y_size, secure_vector<word>& ws);
diff --git a/src/lib/math/mp/mp_core.h b/src/lib/math/mp/mp_core.h
index 514240197..a2c39bafa 100644
--- a/src/lib/math/mp/mp_core.h
+++ b/src/lib/math/mp/mp_core.h
@@ -125,6 +125,7 @@ void bigint_linmul3(word z[], const word x[], size_t x_size, word y);
* @param p_size size of p
* @param p_dash Montgomery value
* @param workspace array of at least 2*(p_size+1) words
+* @param ws_size size of workspace in words
*/
void bigint_monty_redc(word z[],
const word p[], size_t p_size,
diff --git a/src/lib/misc/fpe_fe1/fpe_fe1.h b/src/lib/misc/fpe_fe1/fpe_fe1.h
index e823a5d3c..d9f760f0d 100644
--- a/src/lib/misc/fpe_fe1/fpe_fe1.h
+++ b/src/lib/misc/fpe_fe1/fpe_fe1.h
@@ -50,6 +50,7 @@ class BOTAN_PUBLIC_API(2,5) FPE_FE1 final : public SymmetricAlgorithm
* Encrypt X from and onto the group Z_n using key and tweak
* @param x the plaintext to encrypt <= n
* @param tweak will modify the ciphertext
+ * @param tweak_len length of tweak
*/
BigInt encrypt(const BigInt& x, const uint8_t tweak[], size_t tweak_len) const;
@@ -57,6 +58,7 @@ class BOTAN_PUBLIC_API(2,5) FPE_FE1 final : public SymmetricAlgorithm
* Decrypt X from and onto the group Z_n using key and tweak
* @param x the ciphertext to encrypt <= n
* @param tweak must match the value used to encrypt
+ * @param tweak_len length of tweak
*/
BigInt decrypt(const BigInt& x, const uint8_t tweak[], size_t tweak_len) const;
diff --git a/src/lib/pubkey/ec_group/point_gfp.h b/src/lib/pubkey/ec_group/point_gfp.h
index 80c198c62..2a9948fde 100644
--- a/src/lib/pubkey/ec_group/point_gfp.h
+++ b/src/lib/pubkey/ec_group/point_gfp.h
@@ -204,6 +204,7 @@ class BOTAN_PUBLIC_API(2,0) PointGFp final
/**
* Point addition
+ * @param other the point to add to *this
* @param workspace temp space, at least WORKSPACE_SIZE elements
*/
void add(const PointGFp& other, std::vector<BigInt>& workspace);
@@ -215,6 +216,15 @@ class BOTAN_PUBLIC_API(2,0) PointGFp final
*/
void add_affine(const PointGFp& other, std::vector<BigInt>& workspace);
+ /**
+ * Point addition - mixed J+A. Array version.
+ *
+ * @param x_words the words of the x coordinate of the other point
+ * @param x_size size of x_words
+ * @param y_words the words of the y coordinate of the other point
+ * @param y_size size of y_words
+ * @param workspace temp space, at least WORKSPACE_SIZE elements
+ */
void add_affine(const word x_words[], size_t x_size,
const word y_words[], size_t y_size,
std::vector<BigInt>& workspace);
@@ -227,7 +237,9 @@ class BOTAN_PUBLIC_API(2,0) PointGFp final
/**
* Point addition
+ * @param other the point to add to *this
* @param workspace temp space, at least WORKSPACE_SIZE elements
+ * @return other plus *this
*/
PointGFp plus(const PointGFp& other, std::vector<BigInt>& workspace) const
{