From bf60e86d40d8ffcef3d84dcc401faff8dcc5e228 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Henrik=20Grubbstr=C3=B6m=20=28Grubba=29?=
 <grubba@grubba.org>
Date: Sat, 15 Nov 2014 11:45:08 +0100
Subject: [PATCH] Nettle.ECC_Curve: Improved documentation about point_mul().

Added note that point_mul() validates that the coordinate
is valid for the curve.
---
 src/post_modules/Nettle/hogweed.cmod | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/src/post_modules/Nettle/hogweed.cmod b/src/post_modules/Nettle/hogweed.cmod
index ad5d5ffd7f..46014e81b7 100644
--- a/src/post_modules/Nettle/hogweed.cmod
+++ b/src/post_modules/Nettle/hogweed.cmod
@@ -492,6 +492,9 @@ PIKECLASS ECC_Curve
    *!
    *! @returns
    *!   Returns the new point on the curve.
+   *!
+   *! @throws
+   *!   Throws an error if the point (@[x], @[y]) isn't on the curve.
    */
   PIKEFUN array(object(Gmp.mpz)) point_mul(object(Gmp.mpz)|int x,
 					   object(Gmp.mpz)|int y,
-- 
GitLab