Add some basic documentation

Author: milliams

src/plot.rs

@@ -1,3 +1,7 @@
+/*!
+The `plot` module provides structures for laying out and rendering multiple views.
+*/
+
 use std::path::Path;
 use std::ffi::OsStr;
 
@@ -7,19 +11,28 @@ use svg::Document;
 
 use view::View;
 
+/**
+A single page plot laying out the views in a grid
+*/
 pub struct Plot<'a> {
-    pub views: Vec<&'a View<'a>>,
+    views: Vec<&'a View<'a>>,
     num_views: u32,
 }
 
 impl<'a> Plot<'a> {
+    /**
+    Creates a plot containing a single view
+    */
     pub fn single(view: &'a View) -> Self {
         Plot {
             views: vec![view],
             num_views: 1,
         }
     }
 
+    /**
+    Render the plot to an svg document
+    */
     pub fn to_svg(&self) -> svg::Document {
         let mut document = Document::new().set("viewBox", (0, 0, 600, 400));
         for &view in self.views.iter() {
@@ -30,12 +43,21 @@ impl<'a> Plot<'a> {
         document
     }
 
+    /**
+    Render the plot to an `String`
+    */
     pub fn to_text(&self) -> String {
         // TODO compose multiple views into a plot
         let view = self.views[0];
         view.to_text(90, 30)
     }
 
+    /**
+    Save the plot to a file.
+
+    The type of file will be based on the file extension.
+    */
+
     pub fn save<P>(&self, path: P)
         where P: AsRef<Path>
     {

src/scatter.rs

@@ -7,6 +7,9 @@ use svg_render;
 use text_render;
 use representation::Representation;
 
+/**
+The marker that should be used for the points of the scatter plot
+*/
 #[derive(Debug,Clone)]
 pub enum Marker {
     Circle,
@@ -43,7 +46,9 @@ impl Style {
         }
     }
 
-    pub fn marker<T>(mut self, value: T) -> Self where T: Into<Marker> {
+    pub fn marker<T>(mut self, value: T) -> Self
+        where T: Into<Marker>
+    {
         self.marker = Some(value.into());
         self
     }
@@ -55,7 +60,9 @@ impl Style {
         }
     }
 
-    pub fn colour<T>(mut self, value: T) -> Self where T: Into<String> {
+    pub fn colour<T>(mut self, value: T) -> Self
+        where T: Into<String>
+    {
         self.colour = Some(value.into());
         self
     }

src/view.rs

@@ -1,3 +1,7 @@
+/*!
+The `view` module provides structures for showing data in various ways.
+*/
+
 use std;
 use std::f64;
 
@@ -17,6 +21,9 @@ pub struct View<'a> {
 }
 
 impl<'a> View<'a> {
+    /**
+    Create an empty view
+    */
     pub fn new() -> View<'a> {
         View {
             representations: vec![],
@@ -25,16 +32,25 @@ impl<'a> View<'a> {
         }
     }
 
+    /**
+    Add a representation to the view
+    */
     pub fn add(mut self, repr: &'a Representation) -> Self {
         self.representations.push(repr);
         self
     }
 
+    /**
+    Set the x range for the view
+    */
     pub fn x_range(mut self, min: f64, max: f64) -> Self {
         self.x_range = Some(axis::Range::new(min, max));
         self
     }
 
+    /**
+    Set the y range for the view
+    */
     pub fn y_range(mut self, min: f64, max: f64) -> Self {
         self.y_range = Some(axis::Range::new(min, max));
         self
@@ -62,6 +78,9 @@ impl<'a> View<'a> {
         axis::Range::new(y_min, y_max)
     }
 
+    /**
+    Create an SVG rendering of the view
+    */
     pub fn to_svg(&self, face_width: f64, face_height: f64) -> svg::node::element::Group {
         let mut view_group = svg::node::element::Group::new();
 
@@ -86,6 +105,9 @@ impl<'a> View<'a> {
         view_group
     }
 
+    /**
+    Create a text rendering of the view
+    */
     pub fn to_text(&self, face_width: u32, face_height: u32) -> String {
         let default_x_range = self.default_x_range();
         let x_range = self.x_range.as_ref().unwrap_or(&default_x_range);