From 6fe5a8cdef8b36b4f70fc51f165b945c2f47236d Mon Sep 17 00:00:00 2001
From: Sebastian Schmidt <isibboi@gmail.com>
Date: Tue, 19 Mar 2019 20:24:03 +0200
Subject: [PATCH] Document toplevel functions

Implements #6
---
 src/lib.rs | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 50 insertions(+)

diff --git a/src/lib.rs b/src/lib.rs
index 21e7710..4745995 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -222,10 +222,36 @@ pub use function::Function;
 pub use tree::Node;
 pub use value::Value;
 
+/// Evaluate the given expression string.
+///
+/// # Examples
+///
+/// ```rust
+/// use evalexpr::*;
+///
+/// assert_eq!(eval("1 + 2 + 3"), Ok(Value::from(6)));
+/// ```
+///
+/// *See the [crate doc](index.html) for more examples and explanations of the expression format.*
 pub fn eval(string: &str) -> Result<Value, Error> {
     tree::tokens_to_operator_tree(token::tokenize(string)?)?.eval(&EmptyConfiguration)
 }
 
+/// Evaluate the given expression string with the given configuration.
+///
+/// # Examples
+///
+/// ```rust
+/// use evalexpr::*;
+///
+/// let mut configuration = HashMapConfiguration::new();
+/// configuration.insert_variable("one", 1);
+/// configuration.insert_variable("two", 2);
+/// configuration.insert_variable("three", 3);
+/// assert_eq!(eval_with_configuration("one + two + three", &configuration), Ok(Value::from(6)));
+/// ```
+///
+/// *See the [crate doc](index.html) for more examples and explanations of the expression format.*
 pub fn eval_with_configuration(
     string: &str,
     configuration: &Configuration,
@@ -233,6 +259,30 @@ pub fn eval_with_configuration(
     tree::tokens_to_operator_tree(token::tokenize(string)?)?.eval(configuration)
 }
 
+/// Build the operator tree for the given expression string.
+///
+/// The operator tree can later on be evaluated directly.
+/// This saves runtime if a single expression should be evaluated multiple times, for example with differing configurations.
+///
+/// # Examples
+///
+/// ```rust
+/// use evalexpr::*;
+///
+/// let precomputed = build_operator_tree("one + two + three").unwrap();
+///
+/// let mut configuration = HashMapConfiguration::new();
+/// configuration.insert_variable("one", 1);
+/// configuration.insert_variable("two", 2);
+/// configuration.insert_variable("three", 3);
+///
+/// assert_eq!(precomputed.eval(&configuration), Ok(Value::from(6)));
+///
+/// configuration.insert_variable("three", 5);
+/// assert_eq!(precomputed.eval(&configuration), Ok(Value::from(8)));
+/// ```
+///
+/// *See the [crate doc](index.html) for more examples and explanations of the expression format.*
 pub fn build_operator_tree(string: &str) -> Result<Node, Error> {
     tree::tokens_to_operator_tree(token::tokenize(string)?)
 }