From a924ff4509ab71298dc70e197dcc004ff13be39f Mon Sep 17 00:00:00 2001 From: Michael Hamburg Date: Thu, 29 Jan 2015 15:27:56 -0800 Subject: [PATCH] comments --- include/decaf.h | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/include/decaf.h b/include/decaf.h index 4632913..a18e19a 100644 --- a/include/decaf.h +++ b/include/decaf.h @@ -97,7 +97,7 @@ extern "C" { * function is not WARN_UNUSED because eg challenges in signatures * may need to be longer. * - * TODO: create a decode long function. + * TODO: create a decode long function, and make this WARN_UNUSED. * * @param [in] ser Serialized form of a scalar. * @param [out] out Deserialized form. @@ -265,7 +265,7 @@ void decaf_point_sub ( ) API_VIS NONNULL3; /** - * @brief Multiply a base point by a scalar. + * @brief Multiply a base point by a scalar: scaled = scalar*base. * * @param [out] scaled The scaled point base*scalar * @param [in] base The point to be scaled. @@ -278,7 +278,11 @@ void decaf_point_scalarmul ( ) API_VIS NONNULL3; /** - * @brief Multiply two base points by two scalars. + * @brief Multiply two base points by two scalars: + * scaled = scalar1*base1 + scalar2*base2. + * + * Equivalent to two calls to decaf_point_scalarmul, but may be + * faster. * * @param [out] scaled The scaled point base*scalar * @param [in] base1 A first point to be scaled.