Update generated documentation

Author: Joris-van-der-Wel

api.md

@@ -6,31 +6,31 @@
   * [SymbolTree](#exp_module_symbol-tree--SymbolTree) ⏏
     * [new SymbolTree([description])](#new_module_symbol-tree--SymbolTree_new)
     * [.initialize(object)](#module_symbol-tree--SymbolTree+initialize) ⇒ <code>Object</code>
-    * [.isEmpty(object)](#module_symbol-tree--SymbolTree+isEmpty) ⇒ <code>Boolean</code>
-    * [.first(object)](#module_symbol-tree--SymbolTree+first) ⇒ <code>Object</code>
-    * [.last(object)](#module_symbol-tree--SymbolTree+last) ⇒ <code>Object</code>
-    * [.prev(object)](#module_symbol-tree--SymbolTree+prev) ⇒ <code>Object</code>
-    * [.next(object)](#module_symbol-tree--SymbolTree+next) ⇒ <code>Object</code>
+    * [.hasChildren(object)](#module_symbol-tree--SymbolTree+hasChildren) ⇒ <code>Boolean</code>
+    * [.firstChild(object)](#module_symbol-tree--SymbolTree+firstChild) ⇒ <code>Object</code>
+    * [.lastChild(object)](#module_symbol-tree--SymbolTree+lastChild) ⇒ <code>Object</code>
+    * [.previousSibling(object)](#module_symbol-tree--SymbolTree+previousSibling) ⇒ <code>Object</code>
+    * [.nextSibling(object)](#module_symbol-tree--SymbolTree+nextSibling) ⇒ <code>Object</code>
     * [.parent(object)](#module_symbol-tree--SymbolTree+parent) ⇒ <code>Object</code>
     * [.lastInclusiveDescendant(object)](#module_symbol-tree--SymbolTree+lastInclusiveDescendant) ⇒ <code>Object</code>
-    * [.preceding(object, [treeRoot])](#module_symbol-tree--SymbolTree+preceding) ⇒ <code>Object</code>
-    * [.following(object, [treeRoot], [skipChildren])](#module_symbol-tree--SymbolTree+following) ⇒ <code>Object</code>
-    * [.childrenToArray(parent, [array], [filter], [thisArg])](#module_symbol-tree--SymbolTree+childrenToArray) ⇒ <code>Array.&lt;Object&gt;</code>
-    * [.ancestorsToArray(object, [array], [filter], [thisArg])](#module_symbol-tree--SymbolTree+ancestorsToArray) ⇒ <code>Array.&lt;Object&gt;</code>
-    * [.treeToArray(root, [array], [filter], [thisArg])](#module_symbol-tree--SymbolTree+treeToArray) ⇒ <code>Array.&lt;Object&gt;</code>
-    * [.childrenIterator(parent, [reverse])](#module_symbol-tree--SymbolTree+childrenIterator) ⇒ <code>Object</code>
+    * [.preceding(object, [options])](#module_symbol-tree--SymbolTree+preceding) ⇒ <code>Object</code>
+    * [.following(object, [options])](#module_symbol-tree--SymbolTree+following) ⇒ <code>Object</code>
+    * [.childrenToArray(parent, [options])](#module_symbol-tree--SymbolTree+childrenToArray) ⇒ <code>Array.&lt;Object&gt;</code>
+    * [.ancestorsToArray(object, [options])](#module_symbol-tree--SymbolTree+ancestorsToArray) ⇒ <code>Array.&lt;Object&gt;</code>
+    * [.treeToArray(root, [options])](#module_symbol-tree--SymbolTree+treeToArray) ⇒ <code>Array.&lt;Object&gt;</code>
+    * [.childrenIterator(parent, [options])](#module_symbol-tree--SymbolTree+childrenIterator) ⇒ <code>Object</code>
     * [.prevSiblingsIterator(object)](#module_symbol-tree--SymbolTree+prevSiblingsIterator) ⇒ <code>Object</code>
     * [.nextSiblingsIterator(object)](#module_symbol-tree--SymbolTree+nextSiblingsIterator) ⇒ <code>Object</code>
     * [.ancestorsIterator(object)](#module_symbol-tree--SymbolTree+ancestorsIterator) ⇒ <code>Object</code>
-    * [.treeIterator(root, [reverse])](#module_symbol-tree--SymbolTree+treeIterator) ⇒ <code>Object</code>
+    * [.treeIterator(root, options)](#module_symbol-tree--SymbolTree+treeIterator) ⇒ <code>Object</code>
     * [.index(child)](#module_symbol-tree--SymbolTree+index) ⇒ <code>Number</code>
     * [.childrenCount(parent)](#module_symbol-tree--SymbolTree+childrenCount) ⇒ <code>Number</code>
     * [.compareTreePosition(left, right)](#module_symbol-tree--SymbolTree+compareTreePosition) ⇒ <code>Number</code>
     * [.remove(removeObject)](#module_symbol-tree--SymbolTree+remove) ⇒ <code>Object</code>
-    * [.insertBefore(newObject, referenceObject)](#module_symbol-tree--SymbolTree+insertBefore) ⇒ <code>Object</code>
-    * [.insertAfter(newObject, referenceObject)](#module_symbol-tree--SymbolTree+insertAfter) ⇒ <code>Object</code>
-    * [.insertFirst(newObject, referenceObject)](#module_symbol-tree--SymbolTree+insertFirst) ⇒ <code>Object</code>
-    * [.insertLast(newObject, referenceObject)](#module_symbol-tree--SymbolTree+insertLast) ⇒ <code>Object</code>
+    * [.insertBefore(referenceObject, newObject)](#module_symbol-tree--SymbolTree+insertBefore) ⇒ <code>Object</code>
+    * [.insertAfter(referenceObject, newObject)](#module_symbol-tree--SymbolTree+insertAfter) ⇒ <code>Object</code>
+    * [.prependChild(referenceObject, newObject)](#module_symbol-tree--SymbolTree+prependChild) ⇒ <code>Object</code>
+    * [.appendChild(referenceObject, newObject)](#module_symbol-tree--SymbolTree+appendChild) ⇒ <code>Object</code>
 
 <a name="exp_module_symbol-tree--SymbolTree"></a>
 ### SymbolTree ⏏
@@ -57,9 +57,9 @@ freeze your object.
 | --- | --- |
 | object | <code>Object</code> | 
 
-<a name="module_symbol-tree--SymbolTree+isEmpty"></a>
-#### symbolTree.isEmpty(object) ⇒ <code>Boolean</code>
-Returns false if the object has any children. Otherwise it returns true.
+<a name="module_symbol-tree--SymbolTree+hasChildren"></a>
+#### symbolTree.hasChildren(object) ⇒ <code>Boolean</code>
+Returns `true` if the object has any children. Otherwise it returns `false`.
 
 `O(1)`
 
@@ -69,8 +69,8 @@ Returns false if the object has any children. Otherwise it returns true.
 | --- | --- |
 | object | <code>Object</code> | 
 
-<a name="module_symbol-tree--SymbolTree+first"></a>
-#### symbolTree.first(object) ⇒ <code>Object</code>
+<a name="module_symbol-tree--SymbolTree+firstChild"></a>
+#### symbolTree.firstChild(object) ⇒ <code>Object</code>
 Return the first child of the given object.
 
 `O(1)`
@@ -81,8 +81,8 @@ Return the first child of the given object.
 | --- | --- |
 | object | <code>Object</code> | 
 
-<a name="module_symbol-tree--SymbolTree+last"></a>
-#### symbolTree.last(object) ⇒ <code>Object</code>
+<a name="module_symbol-tree--SymbolTree+lastChild"></a>
+#### symbolTree.lastChild(object) ⇒ <code>Object</code>
 Return the last child of the given object.
 
 `O(1)`
@@ -93,8 +93,8 @@ Return the last child of the given object.
 | --- | --- |
 | object | <code>Object</code> | 
 
-<a name="module_symbol-tree--SymbolTree+prev"></a>
-#### symbolTree.prev(object) ⇒ <code>Object</code>
+<a name="module_symbol-tree--SymbolTree+previousSibling"></a>
+#### symbolTree.previousSibling(object) ⇒ <code>Object</code>
 Return the previous sibling of the given object.
 
 `O(1)`
@@ -105,9 +105,9 @@ Return the previous sibling of the given object.
 | --- | --- |
 | object | <code>Object</code> | 
 
-<a name="module_symbol-tree--SymbolTree+next"></a>
-#### symbolTree.next(object) ⇒ <code>Object</code>
-Return the next sibling of the given object.
+<a name="module_symbol-tree--SymbolTree+nextSibling"></a>
+#### symbolTree.nextSibling(object) ⇒ <code>Object</code>
+Return the nextSibling sibling of the given object.
 
 `O(1)`
 
@@ -142,7 +142,7 @@ Find the inclusive descendant that is last in tree order of the given object.
 | object | <code>Object</code> | 
 
 <a name="module_symbol-tree--SymbolTree+preceding"></a>
-#### symbolTree.preceding(object, [treeRoot]) ⇒ <code>Object</code>
+#### symbolTree.preceding(object, [options]) ⇒ <code>Object</code>
 Find the preceding object (A) of the given object (B).
 An object A is preceding an object B if A and B are in the same tree
 and A comes before B in tree order.
@@ -154,10 +154,11 @@ and A comes before B in tree order.
 | Param | Type | Description |
 | --- | --- | --- |
 | object | <code>Object</code> |  |
-| [treeRoot] | <code>Object</code> | If set, `treeRoot` must be an inclusive ancestor        of the return value (or else null is returned). This check _assumes_        that `root` is also an inclusive ancestor of the given `node` |
+| [options] | <code>Object</code> |  |
+| [options.root] | <code>Object</code> | If set, `root` must be an inclusive ancestor        of the return value (or else null is returned). This check _assumes_        that `root` is also an inclusive ancestor of the given `node` |
 
 <a name="module_symbol-tree--SymbolTree+following"></a>
-#### symbolTree.following(object, [treeRoot], [skipChildren]) ⇒ <code>Object</code>
+#### symbolTree.following(object, [options]) ⇒ <code>Object</code>
 Find the following object (A) of the given object (B).
 An object A is following an object B if A and B are in the same tree
 and A comes after B in tree order.
@@ -169,11 +170,12 @@ and A comes after B in tree order.
 | Param | Type | Default | Description |
 | --- | --- | --- | --- |
 | object | <code>Object</code> |  |  |
-| [treeRoot] | <code>Object</code> |  | If set, `treeRoot` must be an inclusive ancestor        of the return value (or else null is returned). This check _assumes_        that `root` is also an inclusive ancestor of the given `node` |
-| [skipChildren] | <code>Boolean</code> | <code>false</code> | If set, ignore the childen of `object` |
+| [options] | <code>Object</code> |  |  |
+| [options.root] | <code>Object</code> |  | If set, `root` must be an inclusive ancestor        of the return value (or else null is returned). This check _assumes_        that `root` is also an inclusive ancestor of the given `node` |
+| [options.skipChildren] | <code>Boolean</code> | <code>false</code> | If set, ignore the children of `object` |
 
 <a name="module_symbol-tree--SymbolTree+childrenToArray"></a>
-#### symbolTree.childrenToArray(parent, [array], [filter], [thisArg]) ⇒ <code>Array.&lt;Object&gt;</code>
+#### symbolTree.childrenToArray(parent, [options]) ⇒ <code>Array.&lt;Object&gt;</code>
 Append all children of the given object to an array.
 
 `O(n)`
@@ -183,12 +185,13 @@ Append all children of the given object to an array.
 | Param | Type | Default | Description |
 | --- | --- | --- | --- |
 | parent | <code>Object</code> |  |  |
-| [array] | <code>Array.&lt;Object&gt;</code> | <code>[]</code> |  |
-| [filter] | <code>function</code> |  | Function to test each object before it is added to the array.                            Invoked with arguments (object). Should return `true` if an object                            is to be included. |
-| [thisArg] | <code>\*</code> |  | Value to use as `this` when executing `filter`. |
+| [options] | <code>Object</code> |  |  |
+| [options.array] | <code>Array.&lt;Object&gt;</code> | <code>[]</code> |  |
+| [options.filter] | <code>function</code> |  | Function to test each object before it is added to the array.                            Invoked with arguments (object). Should return `true` if an object                            is to be included. |
+| [options.thisArg] | <code>\*</code> |  | Value to use as `this` when executing `filter`. |
 
 <a name="module_symbol-tree--SymbolTree+ancestorsToArray"></a>
-#### symbolTree.ancestorsToArray(object, [array], [filter], [thisArg]) ⇒ <code>Array.&lt;Object&gt;</code>
+#### symbolTree.ancestorsToArray(object, [options]) ⇒ <code>Array.&lt;Object&gt;</code>
 Append all inclusive ancestors of the given object to an array.
 
 `O(n)`
@@ -198,12 +201,13 @@ Append all inclusive ancestors of the given object to an array.
 | Param | Type | Default | Description |
 | --- | --- | --- | --- |
 | object | <code>Object</code> |  |  |
-| [array] | <code>Array.&lt;Object&gt;</code> | <code>[]</code> |  |
-| [filter] | <code>function</code> |  | Function to test each object before it is added to the array.                            Invoked with arguments (object). Should return `true` if an object                            is to be included. |
-| [thisArg] | <code>\*</code> |  | Value to use as `this` when executing `filter`. |
+| [options] | <code>Object</code> |  |  |
+| [options.array] | <code>Array.&lt;Object&gt;</code> | <code>[]</code> |  |
+| [options.filter] | <code>function</code> |  | Function to test each object before it is added to the array.                            Invoked with arguments (object). Should return `true` if an object                            is to be included. |
+| [options.thisArg] | <code>\*</code> |  | Value to use as `this` when executing `filter`. |
 
 <a name="module_symbol-tree--SymbolTree+treeToArray"></a>
-#### symbolTree.treeToArray(root, [array], [filter], [thisArg]) ⇒ <code>Array.&lt;Object&gt;</code>
+#### symbolTree.treeToArray(root, [options]) ⇒ <code>Array.&lt;Object&gt;</code>
 Append all descendants of the given object to an array (in tree order).
 
 `O(n)`
@@ -213,12 +217,13 @@ Append all descendants of the given object to an array (in tree order).
 | Param | Type | Default | Description |
 | --- | --- | --- | --- |
 | root | <code>Object</code> |  |  |
-| [array] | <code>Array.&lt;Object&gt;</code> | <code>[]</code> |  |
-| [filter] | <code>function</code> |  | Function to test each object before it is added to the array.                            Invoked with arguments (object). Should return `true` if an object                            is to be included. |
-| [thisArg] | <code>\*</code> |  | Value to use as `this` when executing `filter`. |
+| [options] | <code>Object</code> |  |  |
+| [options.array] | <code>Array.&lt;Object&gt;</code> | <code>[]</code> |  |
+| [options.filter] | <code>function</code> |  | Function to test each object before it is added to the array.                            Invoked with arguments (object). Should return `true` if an object                            is to be included. |
+| [options.thisArg] | <code>\*</code> |  | Value to use as `this` when executing `filter`. |
 
 <a name="module_symbol-tree--SymbolTree+childrenIterator"></a>
-#### symbolTree.childrenIterator(parent, [reverse]) ⇒ <code>Object</code>
+#### symbolTree.childrenIterator(parent, [options]) ⇒ <code>Object</code>
 Iterate over all children of the given object
 
 `O(1)` for a single iteration
@@ -229,7 +234,8 @@ Iterate over all children of the given object
 | Param | Type | Default |
 | --- | --- | --- |
 | parent | <code>Object</code> |  | 
-| [reverse] | <code>Boolean</code> | <code>false</code> | 
+| [options] | <code>Object</code> |  | 
+| [options.reverse] | <code>Boolean</code> | <code>false</code> | 
 
 <a name="module_symbol-tree--SymbolTree+prevSiblingsIterator"></a>
 #### symbolTree.prevSiblingsIterator(object) ⇒ <code>Object</code>
@@ -271,7 +277,7 @@ Iterate over all inclusive ancestors of the given object
 | object | <code>Object</code> | 
 
 <a name="module_symbol-tree--SymbolTree+treeIterator"></a>
-#### symbolTree.treeIterator(root, [reverse]) ⇒ <code>Object</code>
+#### symbolTree.treeIterator(root, options) ⇒ <code>Object</code>
 Iterate over all descendants of the given object (in tree order).
 
 `O(n)` for the entire iteration<br>
@@ -283,7 +289,8 @@ Iterate over all descendants of the given object (in tree order).
 | Param | Type | Default |
 | --- | --- | --- |
 | root | <code>Object</code> |  | 
-| [reverse] | <code>Boolean</code> | <code>false</code> | 
+| options | <code>Object</code> |  | 
+| [options.reverse] | <code>Boolean</code> | <code>false</code> | 
 
 <a name="module_symbol-tree--SymbolTree+index"></a>
 #### symbolTree.index(child) ⇒ <code>Number</code>
@@ -351,7 +358,7 @@ Has no effect if already removed.
 | removeObject | <code>Object</code> | 
 
 <a name="module_symbol-tree--SymbolTree+insertBefore"></a>
-#### symbolTree.insertBefore(newObject, referenceObject) ⇒ <code>Object</code>
+#### symbolTree.insertBefore(referenceObject, newObject) ⇒ <code>Object</code>
 Insert the given object before the reference object.
 `newObject` is now the previous sibling of `referenceObject`.
 
@@ -366,11 +373,11 @@ Insert the given object before the reference object.
 
 | Param | Type |
 | --- | --- |
-| newObject | <code>Object</code> | 
 | referenceObject | <code>Object</code> | 
+| newObject | <code>Object</code> | 
 
 <a name="module_symbol-tree--SymbolTree+insertAfter"></a>
-#### symbolTree.insertAfter(newObject, referenceObject) ⇒ <code>Object</code>
+#### symbolTree.insertAfter(referenceObject, newObject) ⇒ <code>Object</code>
 Insert the given object after the reference object.
 `newObject` is now the next sibling of `referenceObject`.
 
@@ -385,11 +392,11 @@ Insert the given object after the reference object.
 
 | Param | Type |
 | --- | --- |
-| newObject | <code>Object</code> | 
 | referenceObject | <code>Object</code> | 
+| newObject | <code>Object</code> | 
 
-<a name="module_symbol-tree--SymbolTree+insertFirst"></a>
-#### symbolTree.insertFirst(newObject, referenceObject) ⇒ <code>Object</code>
+<a name="module_symbol-tree--SymbolTree+prependChild"></a>
+#### symbolTree.prependChild(referenceObject, newObject) ⇒ <code>Object</code>
 Insert the given object as the first child of the given reference object.
 `newObject` is now the first child of `referenceObject`.
 
@@ -404,11 +411,11 @@ Insert the given object as the first child of the given reference object.
 
 | Param | Type |
 | --- | --- |
-| newObject | <code>Object</code> | 
 | referenceObject | <code>Object</code> | 
+| newObject | <code>Object</code> | 
 
-<a name="module_symbol-tree--SymbolTree+insertLast"></a>
-#### symbolTree.insertLast(newObject, referenceObject) ⇒ <code>Object</code>
+<a name="module_symbol-tree--SymbolTree+appendChild"></a>
+#### symbolTree.appendChild(referenceObject, newObject) ⇒ <code>Object</code>
 Insert the given object as the last child of the given reference object.
 `newObject` is now the last child of `referenceObject`.
 
@@ -423,6 +430,6 @@ Insert the given object as the last child of the given reference object.
 
 | Param | Type |
 | --- | --- |
-| newObject | <code>Object</code> | 
 | referenceObject | <code>Object</code> | 
+| newObject | <code>Object</code> |