Merge pull request steveklabnik#103 from euclio/error-doc

add docs to error chain

Author: steveklabnik

src/error.rs

@@ -1,34 +1,33 @@
-#![allow(missing_docs)]
+//! Error types, traits and aliases.
 
-// TODO: Figure out how to document error-chain items in the macro
 error_chain! {
     errors {
-        // Thrown whenever a crate cannot be found
+        /// Thrown whenever a crate cannot be found
         CrateErr(crate_name: String) {
             description("Crate not found")
             display("Crate not found: \"{}\"", crate_name)
         }
 
-        // Thrown whenever Cargo fails to run properly when getting data for `rustdoc`
+        /// Thrown whenever Cargo fails to run properly when getting data for `rustdoc`
         Cargo(status: ::std::process::ExitStatus, stderr: String) {
             description("Cargo command failed to run")
             display("Cargo failed with status {}. stderr:\n{}", status, stderr)
         }
 
-        // Thrown whenever the `JSON` grabbed from somewhere else is not what is expected.
-        // This is usually thrown when grabbing data output from `Cargo`
+        /// Thrown whenever the `JSON` grabbed from somewhere else is not what is expected.
+        /// This is usually thrown when grabbing data output from `Cargo`
         Json(location: &'static str) {
             description("Unexpected JSON response")
             display("Unexpected JSON response from {}", location)
         }
     }
 
     foreign_links {
-        // `std::io::Error` converted to an error-chain variant
-        Io(::std::io::Error);
-        // `serde_json::Error` converted to an error-chain variant
-        Serde(::serde_json::Error);
-        // `analysis::AError` converted to an error-chain variant
-        Analysis(::analysis::AError);
+        Io(::std::io::Error)
+            #[doc = "`std::io::Error` converted to an error-chain variant"];
+        Serde(::serde_json::Error)
+            #[doc = "`serde_json::Error` converted to an error-chain variant"];
+        Analysis(::analysis::AError)
+            #[doc = "`analysis::AError` converted to an error-chain variant"];
     }
 }