DOC: Added docs for CLI and loggings

enigma-core/app/src/cli.rs

@@ -1,3 +1,10 @@
+//! # Enigma Core CLI.
+//!
+//! We use `StructOpt` to easily generate the CLI https://github.com/TeXitoi/structopt <br>
+//! it uses rustdocs for the `--help` menu, and proc macros to get long/short and parsing methods. <br>
+//! it is used by running `let opt: Opt = Opt::from_args();` and thn it will fill up the struct from the user inputs.
+//! (and of course fail if needed)
+
 use std::path::PathBuf;
 use structopt::StructOpt;
 

enigma-crypto/src/hash.rs

@@ -17,6 +17,7 @@ use enigma_types::Hash256;
 /// let ready = hash::prepare_hash_multiple(&[msg, msg2]);
 /// ```
 #[cfg(any(feature = "sgx", feature = "std"))]
+#[allow(unused_imports)]
 pub fn prepare_hash_multiple<B: AsRef<[u8]>>(messages: &[B]) -> crate::localstd::vec::Vec<u8> {
     use crate::localstd::{vec::Vec, mem};
     let mut res = Vec::with_capacity(messages.len() * mem::size_of::<usize>());

enigma-tools-u/src/common_u/logging.rs

@@ -1,5 +1,13 @@
-use std::{fs::{self, File}, path::Path};
+//! # Enigma Core Logging.
+//!
+//! For logs we use the official `log` facade (https://github.com/rust-lang-nursery/log) <br>
+//! This module returns loggers according to the inputs (a file logger and a stdout logger) <br>
+//! they catch the logs themselves from the `log` facade. <br>
+//! Default verbosity for stdout logger is `Error` and each verbose level will increase it accordingly. <br>
+//! Default verbosity for the file logger is `Warn` and it's always one level above the stdout logger. <br>
+
 
+use std::{fs::{self, File}, path::Path};
 use failure::Error;
 use log::LevelFilter;
 use simplelog::{SharedLogger, WriteLogger};