Update docs - part1

src/constant.rs

@@ -13,6 +13,7 @@ pub fn get_binary() -> String {
     path::Path::new(&binary).file_name().unwrap().to_str().unwrap().to_string()
 }
 
+/// Struct to store the cargo information
 #[derive(Debug)]
 pub struct Cargo {
     pub binary: String,
@@ -30,10 +31,12 @@ pub struct Cargo {
     pub pkg_version_pre: String,
 }
 
+/// Uses compile time macros to load Cargo metadata via environment variables during compilation process
+///
 /// ## References
-/// - https://doc.rust-lang.org/cargo/reference/environment-variables.html
-/// - https://github.com/rust-lang/cargo/issues/8251#issuecomment-631731144
-/// - https://github.com/rust-lang/cargo/issues/11966#issue-1664748892
+/// - [Official Docs](https://doc.rust-lang.org/cargo/reference/environment-variables.html)
+/// - [GitHub Issues](https://github.com/rust-lang/cargo/issues/8251#issuecomment-631731144)
+/// - [GitHub Issues](https://github.com/rust-lang/cargo/issues/11966#issue-1664748892)
 pub fn build_info() -> Cargo {
     let cargo = Cargo {
         binary: get_binary(),
@@ -57,10 +60,7 @@ lazy_static! {
     pub static ref FERNET: Fernet = Fernet::new(&generate_key()).unwrap();
 }
 
-/// Create a Fernet object to encrypt and decrypt session token.
-///
-/// ## References:
-/// https://docs.rs/fernet/latest/fernet/
+/// Create a [Fernet](https://docs.rs/fernet/latest/fernet/) object to encrypt and decrypt session token.
 fn generate_key() -> String {
     Fernet::generate_key()
 }

src/lib.rs

@@ -11,6 +11,15 @@ mod template;
 mod constant;
 mod routes;
 
+/// Contains entrypoint and initializer settings to trigger the asynchronous HTTPServer
+///
+/// # Example
+/// ```no_run
+/// #[actix_rt::main]
+/// async fn main() {
+///     rustream::start().await.unwrap();
+/// }
+/// ```
 pub async fn start() -> io::Result<()> {
     let cargo = constant::build_info();
     let args = squire::parser::arguments();

src/squire/secure.rs

@@ -7,8 +7,8 @@ use sha2::{Digest, Sha512};
 
 /// Generates hash value for the given payload using sha512 algorithm
 ///
-/// References:
-///     https://docs.rs/sha2/latest/sha2/#usage
+/// ## References:
+/// - [Official docs](https://docs.rs/sha2/latest/sha2/#usage)
 pub fn calculate_hash(value: String) -> String {
     let mut hasher = Sha512::new();
     hasher.update(value);
@@ -20,17 +20,17 @@ pub fn calculate_hash(value: String) -> String {
 ///
 /// (i.e., a string in which each character in the string is treated as a byte of binary data)
 ///
-/// References:
-///     https://docs.rs/base64/latest/base64/#url-safe-alphabet
+/// ## References:
+/// - [Official docs](https://docs.rs/base64/latest/base64/#url-safe-alphabet)
 #[allow(dead_code)]  // Just for reference
 pub fn base64_encode(value: &str) -> String {
     URL_SAFE.encode(value.as_bytes())
 }
 
 /// Decode a string of data which has been encoded using base64 (similar to the built-in atob function in native JS)
 ///
-/// References:
-///     https://docs.rs/base64/latest/base64/#url-safe-alphabet
+/// ## References:
+/// - [Official Docs](https://docs.rs/base64/latest/base64/#url-safe-alphabet)
 pub fn base64_decode(value: &str) -> Result<String, &'static str> {
     if let Ok(decoded_bytes) = URL_SAFE.decode(value) {
         if let Ok(decoded_str) = String::from_utf8(decoded_bytes) {

src/template.rs

@@ -1,10 +1,17 @@
-/// Create static objects that can be tossed around the modules
-///
-/// References:
-///     https://doc.rust-lang.org/std/macro.include_str.html
+/// Index page template that is served as HTML response for the root endpoint.
 pub static INDEX: &str = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/src/templates/index.html"));
+
+/// Landing page template that is served as HTML response while streaming videos.
 pub static LANDING: &str = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/src/templates/land.html"));
+
+/// Listing page template that is served as HTML response after successful authentication.
 pub static LISTING: &str = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/src/templates/list.html"));
+
+/// Logout page template that is served as HTML response when the user decides to end the session.
 pub static LOGOUT: &str = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/src/templates/logout.html"));
+
+/// Session page template that is served as HTML response when invalid/expired session tokens are received.
 pub static SESSION: &str = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/src/templates/session.html"));
+
+/// Unauthorized page template that is served as HTML response after failed authentication.
 pub static UNAUTHORIZED: &str = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/src/templates/unauthorized.html"));