From 8f352c30f1233c2bdd63a0f0fdb2d91a12326aa9 Mon Sep 17 00:00:00 2001
From: Lireer <Lireer@users.noreply.github.com>
Date: Wed, 14 Oct 2020 16:26:39 +0200
Subject: [PATCH] add missing documentation

---
 src/aes.rs     | 5 +++++
 src/aes_ctr.rs | 1 +
 2 files changed, 6 insertions(+)

diff --git a/src/aes.rs b/src/aes.rs
index 5fa636f2..001a2804 100644
--- a/src/aes.rs
+++ b/src/aes.rs
@@ -62,6 +62,11 @@ impl<R: Read> AesReader<R> {
     /// password was provided.
     /// It isn't possible to check the authentication code in this step. This will be done after
     /// reading and decrypting the file.
+    ///
+    /// # Returns
+    ///
+    /// If the password verification failed `Ok(None)` will be returned to match the validate
+    /// method of ZipCryptoReader.
     pub fn validate(mut self, password: &[u8]) -> io::Result<Option<AesReaderValid<R>>> {
         let salt_length = self.aes_mode.salt_length();
         let key_length = self.aes_mode.key_length();
diff --git a/src/aes_ctr.rs b/src/aes_ctr.rs
index bba4ffe0..c0391277 100644
--- a/src/aes_ctr.rs
+++ b/src/aes_ctr.rs
@@ -132,6 +132,7 @@ where
     }
 }
 
+/// This trait allows using generic AES ciphers with different key sizes.
 pub trait AesCipher {
     fn crypt_in_place(&mut self, target: &mut [u8]);
 }