aboutsummaryrefslogtreecommitdiffstats
path: root/src/lib/pubkey/ec_group
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/pubkey/ec_group
parent5b7cb0d19d7ffe97712c39aaf2f861a2504442aa (diff)
Fix some Doxygen errors
Diffstat (limited to 'src/lib/pubkey/ec_group')
-rw-r--r--src/lib/pubkey/ec_group/point_gfp.h12
1 files changed, 12 insertions, 0 deletions
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
{