feat: update comments

2023-08-27 23:15:16 +08:00
parent eff8cfe574
commit 83941c4ad8
1 changed files with 12 additions and 1 deletions
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -1,4 +1,15 @@
-// ----------------------------------------
+/// This library is created for AES/GCM stream encrypt or decrypt
+///
+/// Structs for encryption:
+/// * Aes128GcmStreamEncryptor
+/// * Aes192GcmStreamEncryptor
+/// * Aes256GcmStreamEncryptor
+///
+/// Structs for decryption:
+/// * Aes128GcmStreamDecryptor
+/// * Aes192GcmStreamDecryptor
+/// * Aes256GcmStreamDecryptor
+
 pub use decryptor::Aes128GcmStreamDecryptor;
 pub use decryptor::Aes192GcmStreamDecryptor;
 pub use decryptor::Aes256GcmStreamDecryptor;