From 66e598a47c5ffceb6f4efaeeaa504c69d5a8cd89 Mon Sep 17 00:00:00 2001 From: Henry de Valence Date: Mon, 20 Feb 2017 00:40:41 -0800 Subject: [PATCH] Minor doc tweaks --- src/decaf.rs | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/decaf.rs b/src/decaf.rs index 4acce55..ade009a 100644 --- a/src/decaf.rs +++ b/src/decaf.rs @@ -9,8 +9,9 @@ // - Isis Agora Lovecruft // - Henry de Valence -//! An implementation of Mike Hamburg's Decaf point-compression scheme, -//! providing a prime-order group. +//! An implementation of Mike Hamburg's Decaf cofactor-eliminating +//! point-compression scheme, providing a prime-order group on top of +//! a non-prime-order elliptic curve. // We allow non snake_case names because coordinates in projective space are // traditionally denoted by the capitalisation of their respective @@ -36,6 +37,7 @@ use curve::ExtendedPoint; #[derive(Copy, Clone, Eq, PartialEq)] pub struct CompressedDecaf(pub [u8; 32]); +/// The result of compressing a `DecafPoint`. impl CompressedDecaf { /// View this `CompressedDecaf` as an array of bytes. pub fn to_bytes(&self) -> [u8;32] {