From 6ec672a1a64b8a20dcddf88d15d68357491bdd2f Mon Sep 17 00:00:00 2001 From: debris Date: Mon, 1 Feb 2016 14:58:13 +0100 Subject: [PATCH] docs for util standard, from_json and common modules --- util/src/common.rs | 2 ++ util/src/from_json.rs | 2 ++ util/src/lib.rs | 3 --- util/src/standard.rs | 2 ++ 4 files changed, 6 insertions(+), 3 deletions(-) diff --git a/util/src/common.rs b/util/src/common.rs index 0f10a4e97..9cf7a3765 100644 --- a/util/src/common.rs +++ b/util/src/common.rs @@ -1,3 +1,5 @@ +//! Utils common types and macros global reexport. + pub use standard::*; pub use from_json::*; pub use error::*; diff --git a/util/src/from_json.rs b/util/src/from_json.rs index 1d95df691..7319ec8aa 100644 --- a/util/src/from_json.rs +++ b/util/src/from_json.rs @@ -1,3 +1,5 @@ +//! Coversion from json. + use standard::*; #[macro_export] diff --git a/util/src/lib.rs b/util/src/lib.rs index 64cbac662..f422db7c8 100644 --- a/util/src/lib.rs +++ b/util/src/lib.rs @@ -82,13 +82,10 @@ extern crate serde; #[macro_use] extern crate log as rlog; -/// TODO [Gav Wood] Please document me pub mod standard; #[macro_use] -/// TODO [Gav Wood] Please document me pub mod from_json; #[macro_use] -/// TODO [Gav Wood] Please document me pub mod common; pub mod error; pub mod hash; diff --git a/util/src/standard.rs b/util/src/standard.rs index 873df6cb4..d1589d30a 100644 --- a/util/src/standard.rs +++ b/util/src/standard.rs @@ -1,3 +1,5 @@ +//! Std lib global reexports. + pub use std::io; pub use std::fs; pub use std::str;