[P256] add comment to `toPoint'

2015-05-03 19:51:21 +01:00 · 2015-05-03 19:51:21 +01:00 · 25c303602d
commit 25c303602d
parent 98463b6dad
1 changed files with 7 additions and 0 deletions
--- a/Crypto/PubKey/ECC/P256.hs
+++ b/Crypto/PubKey/ECC/P256.hs
@ -53,6 +53,13 @@ data P256X
 ------------------------------------------------------------------------
 -- Point methods
 ------------------------------------------------------------------------
+
+-- | Lift to curve a scalar
+--
+-- Using the curve generator as base point compute:
+--
+-- > scalar * G
+--
 toPoint :: Scalar -> Point
 toPoint s = withNewPoint $ \px py -> withScalar s $ \p ->
    ccryptonite_p256_basepoint_mul p px py