From 837087daa9b1598658367ab45ae9775f7f3b8462 Mon Sep 17 00:00:00 2001 From: MedzikUser Date: Sat, 18 Jun 2022 11:35:53 +0200 Subject: [PATCH] add missing doc --- src/lib.rs | 2 ++ src/sha.rs | 3 +++ 2 files changed, 5 insertions(+) diff --git a/src/lib.rs b/src/lib.rs index 449cf78..2090acb 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -81,6 +81,8 @@ //! | `sha` | Enable support for the Sha1, Sha256 and Sha512 hasher | `sha` and `sha2` | yes | //! | `jwt` | Enable support for the Json Web Token utils | `chrono`, `serde` and `jsonwebtoken` | yes | +#![warn(missing_docs)] + #[cfg(feature = "jwt")] pub mod jsonwebtoken; #[cfg(feature = "sha")] diff --git a/src/sha.rs b/src/sha.rs index b95df1d..5d6893e 100644 --- a/src/sha.rs +++ b/src/sha.rs @@ -22,8 +22,11 @@ use sha2::{Sha256, Sha512}; /// Hashing algorithms #[derive(Debug)] pub enum Algorithm { + /// [SHA-1](https://en.wikipedia.org/wiki/SHA-1) SHA1, + /// [SHA-256](https://en.wikipedia.org/wiki/SHA-2) SHA256, + /// [SHA-512](https://en.wikipedia.org/wiki/SHA-2) SHA512, }