Updated docs

Author: ryankurte

src/elementext.rs

@@ -1,4 +1,5 @@
-/// SVD Element Extensions
+//! SVD Element Extensions.
+//! This module is extends xmltree::Element objects with convenience methods
 
 use xmltree::Element;
 
@@ -7,6 +8,7 @@ use failure::ResultExt;
 
 use error::*;
 
+/// Defines extensions for implementation over xmltree::Element
 pub trait ElementExt {
     fn get_child_text_opt<K>(&self, k: K) -> Result<Option<String>, SVDError>
     where
@@ -27,6 +29,7 @@ pub trait ElementExt {
     fn debug(&self);
 }
 
+/// Implements extensions for xmltree::Element
 impl ElementExt for Element {
     fn get_child_text_opt<K>(&self, k: K) -> Result<Option<String>, SVDError>
     where

src/encode.rs

@@ -1,3 +1,5 @@
+//! Encode traits.
+//! These support encoding of SVD types to XML
 
 use xmltree::Element;
 

src/error.rs

@@ -1,3 +1,5 @@
+//! SVD Errors.
+//! This module defines error types and messages for SVD parsing and encoding
 
 use xmltree::{Element, ParseError};
 use failure::{Backtrace, Context, Fail};

src/lib.rs

@@ -37,18 +37,18 @@ use xmltree::Element;
 pub mod elementext;
 // SVD contains svd primitives
 pub mod svd;
-use svd::device::Device;
+pub use svd::*;
 // Error defines SVD error types
 pub mod error;
 use error::{SVDError};
-
+// Parse defines parsing interfaces
 pub mod parse;
 use parse::Parse;
-
+// Encode defines encoding interfaces
 pub mod encode;
 #[cfg(feature = "unproven")]
 use encode::Encode;
-
+// Types defines simple types and parse/encode implementations
 pub mod types;
 
 /// Parses the contents of an SVD (XML) string
@@ -89,7 +89,7 @@ pub (crate) fn new_element(name: &str, text: Option<String>) -> Element {
 #[cfg(test)]
 use std::fmt::Debug;
 #[cfg(test)]
-use types::{Encode};
+use types::Encode;
 
 /// Generic test helper function
 /// Takes an array of (item, xml) pairs where the item implements

src/parse.rs

@@ -1,3 +1,6 @@
+//! Parse traits.
+//! These support parsing of SVD types from XML
+
 use xmltree::Element;
 
 use error::*;

src/svd/mod.rs

@@ -1,22 +1,66 @@
+//! SVD objects.
+//! This module defines components of an SVD along with parse and encode implementations
 
 pub mod endian;
+pub use self::endian::Endian;
+
 pub mod cpu;
+pub use self::cpu::Cpu;
+
 pub mod interrupt;
+pub use self::interrupt::Interrupt;
+
 pub mod access;
+pub use self::access::Access;
+
 pub mod bitrange;
+pub use self::bitrange::BitRange;
+
 pub mod writeconstraint;
+pub use self::writeconstraint::WriteConstraint;
+
 pub mod usage;
+pub use self::usage::Usage;
+
 pub mod enumeratedvalue;
+pub use self::enumeratedvalue::EnumeratedValue;
+
 pub mod enumeratedvalues;
+pub use self::enumeratedvalues::EnumeratedValues;
+
 pub mod field;
+pub use self::field::Field;
+
 pub mod registerinfo;
+pub use self::registerinfo::RegisterInfo;
+
 pub mod defaults;
+pub use self::defaults::Defaults;
+
 pub mod addressblock;
+pub use self::addressblock::AddressBlock;
+
 pub mod cluster;
+pub use self::cluster::Cluster;
+
 pub mod clusterinfo;
+pub use self::clusterinfo::ClusterInfo;
+
 pub mod register;
+pub use self::register::Register;
+
 pub mod registercluster;
+pub use self::registercluster::RegisterCluster;
+
 pub mod registerclusterarrayinfo;
+pub use self::registerclusterarrayinfo::RegisterClusterArrayInfo;
+
 pub mod peripheral;
+pub use self::peripheral::Peripheral;
+
 pub mod device;
+pub use self::device::Device;
+
 pub mod modifiedwritevalues;
+pub use self::modifiedwritevalues::ModifiedWriteValues;
+

src/types.rs

@@ -1,5 +1,4 @@
-// Helper traits for rust-svd
-
+//! Shared primitive types for use in SVD objects.
 
 use xmltree::Element;
 use failure::ResultExt;