From 6109570ccf470ba678ccf2d563a3ee342a1b9a18 Mon Sep 17 00:00:00 2001
From: Elisabeth Henry <liz.henry@ouvaton.org>
Date: Thu, 3 Mar 2016 21:14:32 +0100
Subject: [PATCH] Deny missing docs

---
 src/lib/bookoption.rs | 17 ++++++++++++-----
 src/lib/error.rs      |  1 +
 src/lib/lib.rs        |  2 +-
 3 files changed, 14 insertions(+), 6 deletions(-)

diff --git a/src/lib/bookoption.rs b/src/lib/bookoption.rs
index 1d219e7..cd64216 100644
--- a/src/lib/bookoption.rs
+++ b/src/lib/bookoption.rs
@@ -3,11 +3,18 @@ use error::{Error,Result};
 /// Structure for storing a book option
 #[derive(Debug, PartialEq)]
 pub enum BookOption {
-    String(String), // Stores a string
-    Bool(bool), // stores a boolean
-    Char(char), // stores a char
-    Int(i32), // stores an int
-    Path(String), // Stores a path
+    /// Stores a String
+    String(String),
+    /// Stores a boolean
+    Bool(bool),
+    /// Stores a single char
+    Char(char),
+    /// Stores an int
+    Int(i32),
+    /// Stores a path
+    ///
+    /// Stored the same way as a string, but some base path is usually prepended to it
+    Path(String), 
 }
 
 impl BookOption {
diff --git a/src/lib/error.rs b/src/lib/error.rs
index 06a31a2..639e1ce 100644
--- a/src/lib/error.rs
+++ b/src/lib/error.rs
@@ -85,6 +85,7 @@ impl fmt::Display for Error {
     }
 }
 
+/// Crowbook's Result type, used by many methods that can fail
 pub type Result<T> = result::Result<T, Error>;
 
 
diff --git a/src/lib/lib.rs b/src/lib/lib.rs
index 6bd3a78..2895500 100644
--- a/src/lib/lib.rs
+++ b/src/lib/lib.rs
@@ -93,7 +93,7 @@
 //! assert_eq!(count(&ast), 2);
 //! ```
 
-
+#![deny(missing_docs)]
 
 extern crate pulldown_cmark as cmark;
 extern crate mustache;