More docs

sfackler · sfackler · commit 85f5e4073bb4 · 2015-05-21T20:43:55.000-07:00
diff --git a/src/array.rs b/src/array.rs
@@ -93,20 +93,32 @@ impl<T> Array<T> {
             .0
     }
 
+    /// Returns an iterator over references to the elements of the array in the
+    /// higher-dimensional equivalent of row-major order.
     pub fn iter<'a>(&'a self) -> Iter<'a, T> {
         Iter {
             inner: self.data.iter(),
         }
     }
 
+    /// Returns an iterator over mutable references to the elements of the
+    /// array in the higher-dimensional equivalent of row-major order.
     pub fn iter_mut<'a>(&'a mut self) -> IterMut<'a, T> {
         IterMut {
             inner: self.data.iter_mut(),
         }
     }
 }
 
+/// A trait implemented by types that can index into an `Array`.
 pub trait ArrayIndex {
+    /// Calculates the index into the `Array`'s underlying storage specified
+    /// by the value of `self`.
+    ///
+    /// # Panics
+    ///
+    /// Panics if the value of `self` does not correspond to an in-bounds
+    /// element of the `Array`.
     fn index<T>(&self, array: &Array<T>) -> usize;
 }
 
diff --git a/src/lib.rs b/src/lib.rs
@@ -11,9 +11,12 @@ pub use array::Array;
 pub mod array;
 mod impls;
 
+/// Information about a dimension of an array.
 #[derive(Debug, Clone, Copy, PartialEq, Eq)]
 pub struct Dimension {
+    /// The length of the dimension.
     pub len: usize,
+    /// The index of the first element of the dimension.
     pub lower_bound: isize,
 }
 

Original file line number	Diff line number	Diff line change
`@@ -93,20 +93,32 @@ impl<T> Array<T> {`
`93`	`93`	`.0`
`94`	`94`	`}`
`95`	`95`
	`96`	`+ /// Returns an iterator over references to the elements of the array in the`
	`97`	`+ /// higher-dimensional equivalent of row-major order.`
`96`	`98`	`pub fn iter<'a>(&'a self) -> Iter<'a, T> {`
`97`	`99`	`Iter {`
`98`	`100`	`inner: self.data.iter(),`
`99`	`101`	`}`
`100`	`102`	`}`
`101`	`103`
	`104`	`+ /// Returns an iterator over mutable references to the elements of the`
	`105`	`+ /// array in the higher-dimensional equivalent of row-major order.`
`102`	`106`	`pub fn iter_mut<'a>(&'a mut self) -> IterMut<'a, T> {`
`103`	`107`	`IterMut {`
`104`	`108`	`inner: self.data.iter_mut(),`
`105`	`109`	`}`
`106`	`110`	`}`
`107`	`111`	`}`
`108`	`112`
	`113`	+/// A trait implemented by types that can index into an `Array`.
`109`	`114`	`pub trait ArrayIndex {`
	`115`	+ /// Calculates the index into the `Array`'s underlying storage specified
	`116`	+ /// by the value of `self`.
	`117`	`+ ///`
	`118`	`+ /// # Panics`
	`119`	`+ ///`
	`120`	+ /// Panics if the value of `self` does not correspond to an in-bounds
	`121`	+ /// element of the `Array`.
`110`	`122`	`fn index<T>(&self, array: &Array<T>) -> usize;`
`111`	`123`	`}`
`112`	`124`