document struct fields on themselves

Author: euclio

src/json.rs

@@ -44,48 +44,44 @@ const DATA_SIZE: usize = 1;
 ///             }
 ///         }
 ///     ]
-///}
-///```
-///
-/// ## Fields
-///
-/// - `data`: The top level crate information and documentation
-/// - `included`: The rest of the crate information and documentation
+/// }
+/// ```
 #[derive(Serialize, Debug)]
 pub struct Documentation {
+    /// The top level crate information and documentation
     data: Option<Document>,
+
+    /// The rest of the crate information and documentation
     included: Option<Vec<Document>>,
 }
 
 /// A sub type of the `Documentation` struct. It contains the majority of the data. It can be used
 /// for both the `data` and `included` field in the serialized JSON.
-///
-/// ## Fields
-///
-/// - `ty`: The type of the the item (e.g. "crate", "function", "enum", etc.)
-/// - `id`: The unique identifier associated with this item
-/// - `attributes`: The attributes associated with the item like documentation or it's name
-/// - `relationships`: An optional field used to show the relationship between the crate to the
-///   otheritems in the crate
 #[derive(Serialize, Debug)]
 pub struct Document {
     #[serde(rename = "type")]
+    /// The type of the item (e.g. "crate", "function", "enum", etc.)
     ty: String,
+
+    /// The unique identifier associated with this item
     id: String,
+
+    /// The attributes associated with the item, like documentation or its name
     attributes: HashMap<String, String>,
+
+    /// An optional field used to show the relationship between the crate to the other items in the
+    /// crate
     relationships: Option<HashMap<String, HashMap<String, Vec<Data>>>>,
 }
 
 /// Used to populate the `relationships` `data` field in the serialized JSON
-///
-/// ## Fields
-///
-/// - `ty`: The type of the the item (e.g. "crate", "function", "enum", etc.)
-/// - `id`: The unique identifier associated with this item
 #[derive(Serialize, Debug)]
 pub struct Data {
     #[serde(rename = "type")]
+    /// The type of the item (e.g. "crate", "function", "enum", etc.)
     ty: String,
+
+    /// The unique identifier associated with this item
     id: String,
 }
 

src/lib.rs

@@ -36,16 +36,15 @@ use json::*;
 pub use error::{Error, ErrorKind};
 
 /// A structure that contains various fields that hold data in order to generate doc output.
-///
-/// ## Fields
-///
-/// - `manifest_path`: Path to the directory with the `Cargo.toml` file for the crate being analyzed
-/// - `host`: Contains the Cargo analysis output for the crate being documented
-/// - `assets`: Contains all of the `Asset`s that will be output at the end (e.g. JSON, CSS, HTML
-///             and/or JS)
 pub struct Config {
+    /// Path to the directory with the `Cargo.toml` file for the crate being analyzed
     manifest_path: PathBuf,
+
+    /// Contains the Cargo analysis output for the crate being documented
     host: analysis::AnalysisHost,
+
+    /// Contains all of the `Asset`s that will be output at the end (e.g. JSON, CSS, HTML and/or
+    /// JS)
     assets: Vec<Asset>,
 }