From 978baef596cf55c9cd9db77da1e7bbaf68820132 Mon Sep 17 00:00:00 2001
From: Jacob VanDomelen <Jacob.Vandome15@gmail.com>
Date: Sun, 2 Jun 2019 01:05:10 -0700
Subject: [PATCH] Added more Tree documentation.

---
 gemla/src/bracket/mod.rs     |  2 +-
 gemla/src/file_linked/mod.rs |  5 +--
 gemla/src/main.rs            |  8 ++---
 gemla/src/tests/tree.rs      |  5 +--
 gemla/src/tree/mod.rs        | 66 +++++++++++++++++++++++++++++++++++-
 5 files changed, 76 insertions(+), 10 deletions(-)

diff --git a/gemla/src/bracket/mod.rs b/gemla/src/bracket/mod.rs
index 57eef90..2fc15d3 100644
--- a/gemla/src/bracket/mod.rs
+++ b/gemla/src/bracket/mod.rs
@@ -11,7 +11,7 @@ impl tree::Tree<Uuid> {
         println!("================================");
         println!("Running simulation for node: {}", self.val);
         println!(
-            "With children {} and {}",
+            "With children {} and {}\n",
             tree::Tree::fmt_node(&self.left),
             tree::Tree::fmt_node(&self.right)
         );
diff --git a/gemla/src/file_linked/mod.rs b/gemla/src/file_linked/mod.rs
index 552e28f..74486bb 100644
--- a/gemla/src/file_linked/mod.rs
+++ b/gemla/src/file_linked/mod.rs
@@ -2,6 +2,7 @@ use std::fs;
 use std::str::FromStr;
 use std::fmt;
 use std::string::String;
+use std::string::ToString;
 use std::io::Read;
 use std::io::Write;
 
@@ -12,7 +13,7 @@ pub struct FileLinked<T> {
 
 impl<T> FileLinked<T>
 where
-    T: FromStr + fmt::Display + Default,
+    T: FromStr + ToString + Default,
 {
     pub fn from_file(path: &str) -> Result<FileLinked<T>, String> {
         let meta = fs::metadata(path);
@@ -69,7 +70,7 @@ where
             .open(&self.path)
             .or_else(|_| Err(format!("Unable to open path {}", self.path)))?;
 
-        write!(file, "{}", self.val).or_else(|_| {
+        write!(file, "{}", self.val.to_string()).or_else(|_| {
             Err(String::from("Unable to write to file."))
         })?;
 
diff --git a/gemla/src/main.rs b/gemla/src/main.rs
index 5802220..08bef82 100644
--- a/gemla/src/main.rs
+++ b/gemla/src/main.rs
@@ -3,10 +3,10 @@ extern crate clap;
 extern crate regex;
 
 #[macro_use]
-mod tree;
-mod bracket;
-mod constants;
-mod file_linked;
+pub mod tree;
+pub mod bracket;
+pub mod constants;
+pub mod file_linked;
 
 #[cfg(test)]
 mod tests;
diff --git a/gemla/src/tests/tree.rs b/gemla/src/tests/tree.rs
index 4b3eec4..a6c5aba 100644
--- a/gemla/src/tests/tree.rs
+++ b/gemla/src/tests/tree.rs
@@ -29,9 +29,10 @@ fn test_fmt() {
 
 #[test]
 fn test_fmt_node() {
+    let t = btree!(17, btree!(16), btree!(12));
     assert_eq!(
-        Tree::fmt_node(&Some(Box::new(btree!(17, btree!(16), btree!(12))))),
-        "17"
+        Tree::fmt_node(&t.left),
+        "16"
     );
     assert_eq!(
         Tree::fmt_node(&Some(Box::new(btree!(btree!("foo"))))),
diff --git a/gemla/src/tree/mod.rs b/gemla/src/tree/mod.rs
index e65ae69..3a3c776 100644
--- a/gemla/src/tree/mod.rs
+++ b/gemla/src/tree/mod.rs
@@ -1,7 +1,53 @@
+//! An unbalanced binary tree type where each node has an optional left and right child.
+//! 
+//! # Examples
+//! 
+//! ```
+//! let mut t = Tree::new(1, None, None);
+//! let t2 = Tree::new(2, Some(Box::new(t)), Some(Box::new(Tree::new(3, None, None))));
+//! let s = format!("{}", t2);
+//! 
+//! assert_eq!(s, "(2: (1: _|_)|(3: _|_))");
+//! t.left = Some(Box::new(Tree::new(4, None, None)));
+//! assert_eq!(Tree::fmt_node(t.left), 4);
+//! assert_eq!(Tree::from_str(s), t2);
+//! ```
+//! 
+//! Additionally the `btree!` macro can be used to conveniently initialize trees:
+//! 
+//! ```
+//! # #[macro_use] extern crate tree;
+//! # fn main() {
+//! let t1 = btree!(1,btree!(2),btree!(3))
+//! assert_eq!(format!("{}", t1), "(1: (2: _|_)|(3: _|_)")
+//! # }
+//! ```
+
 use std::fmt;
 use std::str::FromStr;
 use regex::Regex;
 
+/// An unbalanced binary tree type where each node has an optional left and right child.
+/// 
+/// # Examples
+/// 
+/// ```
+/// let mut t = Tree::new(1, None, None);
+/// let t2 = Tree::new(2, Some(Box::new(t)), Some(Box::new(Tree::new(3, None, None))));
+/// let s = format!("{}", t2);
+/// 
+/// assert_eq!(s, "(2: (1: _|_)|(3: _|_))");
+/// t.left = Some(Box::new(Tree::new(4, None, None)));
+/// assert_eq!(Tree::fmt_node(t.left), 4);
+/// assert_eq!(Tree::from_str(s), t2);
+/// ```
+/// 
+/// Additionally the `btree!` macro can be used to conveniently initialize trees:
+/// 
+/// ```
+/// let t1 = btree!(1,btree!(2),btree!(3))
+/// assert_eq!(format!("{}", t1), "(1: (2: _|_)|(3: _|_)")
+/// ```
 #[derive(Default, Clone, PartialEq, Debug)]
 pub struct Tree<T> {
     pub val: T,
@@ -9,6 +55,23 @@ pub struct Tree<T> {
     pub right: Option<Box<Tree<T>>>,
 }
 
+/// Used to construct trees in a cleaner manner. `btree!` takes 3 arguments, the first being the
+/// value of the root node, and the other two being child nodes. The last two arguments are 
+/// optional.
+/// 
+/// ```
+/// // A tree with two child nodes.
+/// let t = btree!(1, btree!(2), btree!(3));
+/// 
+/// // A tree with only a left node.
+/// let t_left = btree!(1, btree!(2),);
+/// 
+/// // A tree with only a right node.
+/// let t_right = btree!(1, ,btree!(3));
+/// 
+/// // A tree with no children nodes.
+/// let t_single = btree!(1)
+/// ```
 #[macro_export]
 macro_rules! btree {
     ($val:expr, $l:expr, $r:expr) => { 
@@ -23,10 +86,11 @@ macro_rules! btree {
 }
 
 impl<T> Tree<T> {
+    /// Constructs a new tree object.
     pub fn new(val: T, left: Option<Box<Tree<T>>>, right: Option<Box<Tree<T>>>) -> Tree<T> {
         Tree { val, left, right }
     }
-
+    
     pub fn fmt_node(t: &Option<Box<Tree<T>>>) -> String
     where
         T: fmt::Display,