1
0
mirror of https://github.com/lise-henry/crowbook synced 2024-11-18 00:13:55 +01:00

Deny missing docs

This commit is contained in:
Elisabeth Henry 2016-03-03 21:14:32 +01:00
parent 54ca041d5a
commit 6109570ccf
3 changed files with 14 additions and 6 deletions

@ -3,11 +3,18 @@ use error::{Error,Result};
/// Structure for storing a book option /// Structure for storing a book option
#[derive(Debug, PartialEq)] #[derive(Debug, PartialEq)]
pub enum BookOption { pub enum BookOption {
String(String), // Stores a string /// Stores a String
Bool(bool), // stores a boolean String(String),
Char(char), // stores a char /// Stores a boolean
Int(i32), // stores an int Bool(bool),
Path(String), // Stores a path /// 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 { impl BookOption {

@ -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>; pub type Result<T> = result::Result<T, Error>;

@ -93,7 +93,7 @@
//! assert_eq!(count(&ast), 2); //! assert_eq!(count(&ast), 2);
//! ``` //! ```
#![deny(missing_docs)]
extern crate pulldown_cmark as cmark; extern crate pulldown_cmark as cmark;
extern crate mustache; extern crate mustache;