Crate documentation

Author: jedisct1

src/lib.rs

@@ -1,28 +1,28 @@
 #![cfg_attr(asm, feature(asm))]
 
-/// Precision is a simple crate to perform measurements using hardware counters.
-///
-/// It is especially useful for performing micro-benchmarks.
-///
-/// Example
-/// ```rust
-/// extern crate precision;
-///
-/// let p = precision::Precision::new(precision::Config::default()).unwrap();
-///
-/// let start = p.now();
-///
-/// let stop = p.now();
-/// let elapsed1 = stop - start;
-///
-/// let start = p.now();
-/// let stop = p.now();
-/// let elapsed2 = stop - start;
-///
-/// let elapsed_total = elapsed1 + elapsed2;
-/// let elapsed_total_secs = elapsed_total.as_secs_f64(&p);
-/// let hw_ticks = elapsed_total.ticks();
-/// ```
+//! Precision is a simple crate to perform measurements using hardware counters.
+//!
+//! It is especially useful for performing micro-benchmarks.
+//!
+//! Example
+//! ```rust
+//! extern crate precision;
+//!
+//! let p = precision::Precision::new(precision::Config::default()).unwrap();
+//!
+//! let start = p.now();
+//!
+//! let stop = p.now();
+//! let elapsed1 = stop - start;
+//!
+//! let start = p.now();
+//! let stop = p.now();
+//! let elapsed2 = stop - start;
+//!
+//! let elapsed_total = elapsed1 + elapsed2;
+//! let elapsed_total_secs = elapsed_total.as_secs_f64(&p);
+//! let hw_ticks = elapsed_total.ticks();
+//! ```
 extern crate libc;
 
 mod config;