update documentation

1 files changed, 18 insertions, 0 deletions

diff --git a/libalee/parser.hpp b/libalee/parser.hpp
index be6f3f7..6af3ef9 100644
--- a/libalee/parser.hpp
+++ b/libalee/parser.hpp
@@ -26,11 +26,29 @@
 class Parser
 {
 public:
+    /**
+     * Parses (and evaluates) the given string using the given state.
+     * The string is stored in the state's input buffer, then parseSource()
+     * works through that using parseWord(). parseWord() will compile or
+     * execute as necessary.
+     */
     static Error parse(State&, const char *);
+
+    /**
+     * Parses (and evaluates) through the words stored in the state's input
+     * buffer.
+     */
     static Error parseSource(State&);
 
 private:
+    /**
+     * Parses the given word using the given state.
+     */
     static Error parseWord(State&, Word);
+
+    /**
+     * Attempts to parse the given word into a number.
+     */
     static Error parseNumber(State&, Word);
 };