From cda33965bcf2ea73c4157ed97c3745ac027fd7c4 Mon Sep 17 00:00:00 2001 From: Jack Lloyd Date: Wed, 28 Mar 2018 03:57:43 -0400 Subject: Fix some Doxygen errors --- src/lib/pubkey/ec_group/point_gfp.h | 12 ++++++++++++ 1 file changed, 12 insertions(+) (limited to 'src/lib/pubkey/ec_group') 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& workspace); @@ -215,6 +216,15 @@ class BOTAN_PUBLIC_API(2,0) PointGFp final */ void add_affine(const PointGFp& other, std::vector& 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& 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& workspace) const { -- cgit v1.2.3