From 7b1328b9b7daf1eb3cf3b3f532cff1d9f408de5f Mon Sep 17 00:00:00 2001
From: daxpedda <daxpedda@gmail.com>
Date: Tue, 20 Jul 2021 14:22:41 +0200
Subject: [PATCH] Add missing documentation

---
 src/errors.rs  | 3 +++
 src/keypair.rs | 1 +
 2 files changed, 4 insertions(+)

diff --git a/src/errors.rs b/src/errors.rs
index 2ee0e72..1590b76 100644
--- a/src/errors.rs
+++ b/src/errors.rs
@@ -101,6 +101,7 @@ impl<T: Debug> Debug for InternalPakeError<T> {
 impl<T: Error> Error for InternalPakeError<T> {}
 
 impl InternalPakeError {
+    /// Convert `InternalPakeError<Infallible>` into `InternalPakeError<T>
     pub fn into_custom<T>(self) -> InternalPakeError<T> {
         match self {
             Self::Custom(_) => unreachable!(),
@@ -187,6 +188,7 @@ impl<T> From<InternalPakeError<T>> for PakeError<T> {
 }
 
 impl PakeError {
+    /// Convert `PakeError<Infallible>` into `PakeError<T>
     pub fn into_custom<T>(self) -> PakeError<T> {
         match self {
             Self::CryptoError(internal_pake_error) => {
@@ -273,6 +275,7 @@ impl<T> From<::std::convert::Infallible> for ProtocolError<T> {
 }
 
 impl ProtocolError {
+    /// Convert `ProtocolError<Infallible>` into `ProtocolError<T>
     pub fn into_custom<T>(self) -> ProtocolError<T> {
         match self {
             Self::VerificationError(pake_error) => {
diff --git a/src/keypair.rs b/src/keypair.rs
index 4f81fe6..c60ea80 100644
--- a/src/keypair.rs
+++ b/src/keypair.rs
@@ -280,6 +280,7 @@ impl<G: Group> SizedBytes for PrivateKey<G> {
 
 /// A trait specifying the requirements for a private key container
 pub trait SecretKey<G: Group>: Clone + Sized + Zeroize {
+    /// Custom error type that can be passed down to `InternalPakeError::Custom`
     type Error;
 
     /// Diffie-Hellman key exchange implementation