Merge pull request #12 from Trivernis/develop

Generic parameters and more doc comments

Cargo.toml

@@ -2,7 +2,7 @@
 name = "asciimath-rs"
 description = "AsciiMath parser"
 repository = "https://github.com/trivernis/asciimath-rs"
-version = "0.6.0"
+version = "0.6.1"
 authors = ["trivernis <trivernis@protonmail.com>"]
 edition = "2018"
 readme = "README.md"

src/lib.rs

@@ -22,10 +22,10 @@ pub(crate) mod utils;
 ///
 /// Example:
 ///
-/// ```rust
+/// ```
 /// let expression = asciimath_rs::parse("sin(2x) + 3".to_string());
 /// ```
-pub fn parse(content: String) -> Expression {
+pub fn parse<S: AsRef<str>>(content: S) -> Expression {
     let mut tokenizer = Tokenizer::new(content);
     let tokens = tokenizer.parse();
     let mut tree_parser = TreeParser::new(tokens);

src/parsing/tokenizer.rs

@@ -19,14 +19,24 @@ pub struct Tokenizer {
 }
 
 impl Tokenizer {
-    pub fn new(text: String) -> Self {
-        let mut chars = text.chars().collect::<Vec<char>>();
+    /// Creates a new AsciiMath tokenizer with a given input string.
+    /// After creation the parse method can be used to parse a list of tokens
+    /// Example:
+    /// ```
+    /// use asciimath_rs::parsing::tokenizer::Tokenizer;
+    ///
+    /// let mut tokenizer = Tokenizer::new("2^(2-i)");
+    /// let tokens = tokenizer.parse();
+    /// ```
+    pub fn new<S: AsRef<str>>(text: S) -> Self {
+        let mut chars = text.as_ref().chars().collect::<Vec<char>>();
         chars.push('\n');
         Self {
             ctm: CharTapeMachine::new(chars),
         }
     }
 
+    /// Parses the input string passed on creation of the tokenizer into a list of tokens
     pub fn parse(&mut self) -> Vec<Token> {
         let mut tokens = Vec::<Token>::new();
         self.ctm.seek_whitespace();

src/parsing/tree_parser.rs

@@ -17,6 +17,21 @@ pub struct TreeParser {
 }
 
 impl TreeParser {
+    /// Creates a new TreeParser that takes tokens parsed by the Tokenizer. The parse method
+    /// can be used to create the Expression tree.
+    /// Example:
+    /// ```
+    /// use asciimath_rs::parsing::tokenizer::Tokenizer;
+    /// use asciimath_rs::parsing::tree_parser::TreeParser;
+    ///
+    /// // use the tokenizer to create a list of tokens
+    /// let mut tokenizer = Tokenizer::new("2*2");
+    /// let tokens = tokenizer.parse();
+    ///
+    /// // use the tree parser to build the expression tree
+    /// let mut tree_parser = TreeParser::new(tokens);
+    /// tree_parser.parse();
+    /// ```
     pub fn new(tokens: Vec<Token>) -> Self {
         Self {
             tokens,
@@ -25,6 +40,7 @@ impl TreeParser {
         }
     }
 
+    /// Creates an expression tree out of the tokens passed to the TreeParser on creation
     pub fn parse(&mut self) -> Expression {
         self.remove_whitespace();
         self.parse_expression()