Doc for IxDynImpl

bluss · bluss · commit fad6ec4fcd74 · 2017-04-03T23:07:51.000+02:00
diff --git a/src/dimension/dynindeximpl.rs b/src/dimension/dynindeximpl.rs
@@ -113,6 +113,11 @@ impl<T: PartialEq> PartialEq for IxDynRepr<T> {
     }
 }
 
+/// Dynamic dimension or index type.
+///
+/// Use `IxDyn` directly. This type implements a dynamic number of
+/// dimensions or indices. Short dimensions are stored inline and don't need
+/// any dynamic memory allocation.
 #[derive(Debug, Clone, PartialEq, Eq, Default)]
 pub struct IxDynImpl(IxDynRepr<Ix>);
 unsafe impl Send for IxDynImpl {}

Original file line number	Diff line number	Diff line change
`@@ -113,6 +113,11 @@ impl<T: PartialEq> PartialEq for IxDynRepr<T> {`
`113`	`113`	`}`
`114`	`114`	`}`
`115`	`115`
	`116`	`+/// Dynamic dimension or index type.`
	`117`	`+///`
	`118`	+/// Use `IxDyn` directly. This type implements a dynamic number of
	`119`	`+/// dimensions or indices. Short dimensions are stored inline and don't need`
	`120`	`+/// any dynamic memory allocation.`
`116`	`121`	`#[derive(Debug, Clone, PartialEq, Eq, Default)]`
`117`	`122`	`pub struct IxDynImpl(IxDynRepr<Ix>);`
`118`	`123`	`unsafe impl Send for IxDynImpl {}`