Misc fixes in the doc.

Author: Yamakaky

src/error_chain.rs

@@ -27,7 +27,9 @@ macro_rules! error_chain {
         /// that is mostly irrelevant for error handling purposes.
         #[derive(Debug)]
         pub struct $error_name {
+            /// The kind of the error.
             pub kind: $error_kind_name,
+            /// Contains the error chain and the backtrace.
             pub state: $crate::State,
         }
 
@@ -192,10 +194,7 @@ macro_rules! error_chain {
             }
         }
 
-        // The Result type
-        // ---------------
-
-        /// Convenient wrapper around std::Result.
+        /// Convenient wrapper around `std::Result`.
         pub type $result_name<T> = ::std::result::Result<T, $error_name>;
     };
 

src/lib.rs

@@ -31,7 +31,7 @@
 //!   optional, boxed `std::error::Error + Send + 'static` object
 //!   (which defines the `cause`, and establishes the links in the
 //!   error chain), and a `Backtrace`.
-//! * This crate additionally defines the  trait ResultExt
+//! * This crate additionally defines the  trait `ResultExt`
 //!   that defines a `chain_err` method. This method
 //!   on all `std::error::Error + Send + 'static` types extends
 //!   the error chain by boxing the current error into an opaque
@@ -213,7 +213,7 @@
 //!
 //! Both types come with a variety of `From` conversions as well:
 //! `Error` can be created from `ErrorKind`, `&str` and `String`,
-//! and the "link" and "foreign_link" error types. `ErrorKind`
+//! and the `links` and `foreign_links` error types. `ErrorKind`
 //! can be created from the corresponding `ErrorKind`s of the link
 //! types, as well as from `&str` and `String`.
 //!

test-doc/src/lib.rs

@@ -4,6 +4,7 @@ extern crate error_chain;
 /// This module is used to check that all generated items are documented.
 #[deny(missing_docs)]
 pub mod doc {
+    /// Inner module.
     pub mod inner {
         error_chain! {
         }