Document return value.

diff --git a/src/assembly/ge.ts b/src/assembly/ge.ts
index 3ea46f45ff6e528c65f024fa7ad2843aba6f4f27..128d87350b4270e919bd0dad71fda55839996da3 100644 (file)
--- a/src/assembly/ge.ts
+++ b/src/assembly/ge.ts
@@ -63,6 +63,9 @@ const v3: FieldElement = fe()
 const vxx: FieldElement = fe()
 const m_root_check: FieldElement = fe()
 const p_root_check: FieldElement = fe()
+/**
+ * @returns -1 if bytes fail to decode to a point, 0 if decoding is successful
+ */
 export function ge_frombytes_negate_vartime (h: ge_p3, s: StaticArray<u8>): i32 {
        fe_frombytes(h.Y, s)
        fe_1(h.Z)