start documentation

glayzzle · Jan 5, 2017 · e07507e · e07507e
1 parent c40d287
commit e07507e
Show file tree

Hide file tree

Showing 3 changed files with 141 additions and 0 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,19 @@
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+
+## API
+
+**Properties**
+
+-   `token` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
+-   `lexer` **Lexer** 
+-   `parser` **Parser** 
+
+### parse
+
+Parsing the specified input
+
+**Parameters**
+
+-   `input`  
+
+Returns **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)** AST
diff --git a/docs/lexer.md b/docs/lexer.md
@@ -0,0 +1,51 @@
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+
+## Lexer
+
+**Parameters**
+
+-   `tokens`  
+
+**Properties**
+
+-   `text` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Current parsed text (attached to current token)
+-   `offset` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Current offset
+-   `token` **([String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number))** Current parsed token
+
+### read
+
+Initialize the lexer with specified text
+
+**Parameters**
+
+-   `input`  
+
+### input
+
+Consumes a char
+
+Returns **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** 
+
+### unput
+
+Revert back the current consumed char
+
+Returns **void** 
+
+### unlex
+
+Revert back the current consumed token
+
+Returns **([String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number))** the previous token
+
+### lex
+
+Consumes the next token (ignores whitespaces)
+
+Returns **([String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number))** the current token
+
+### next
+
+Eats a token (see lex for public usage) including whitespace
+
+Returns **([String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number))** the current token
diff --git a/docs/parser.md b/docs/parser.md
@@ -0,0 +1,71 @@
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+
+## Parser
+
+**Parameters**
+
+-   `lexer`  
+
+**Properties**
+
+-   `lexer` **[Lexer](#lexer)** 
+
+### parse
+
+Parses the specified input
+
+**Parameters**
+
+-   `input`  
+
+Returns **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)** AST
+
+## Lexer
+
+**Parameters**
+
+-   `tokens`  
+
+**Properties**
+
+-   `text` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Current parsed text (attached to current token)
+-   `offset` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Current offset
+-   `token` **([String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number))** Current parsed token
+
+### read
+
+Initialize the lexer with specified text
+
+**Parameters**
+
+-   `input`  
+
+### input
+
+Consumes a char
+
+Returns **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** 
+
+### unput
+
+Revert back the current consumed char
+
+Returns **void** 
+
+### unlex
+
+Revert back the current consumed token
+
+Returns **([String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number))** the previous token
+
+### lex
+
+Consumes the next token (ignores whitespaces)
+
+Returns **([String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number))** the current token
+
+### next
+
+Eats a token (see lex for public usage) including whitespace
+
+Returns **([String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number))** the current token