Skip to content

Commit

Permalink
regenerate documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Joris-van-der-Wel committed Jul 18, 2015
1 parent 83ff16d commit 47308cf
Showing 1 changed file with 29 additions and 1 deletion.
30 changes: 29 additions & 1 deletion api.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@
* [.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)](#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)](#module_symbol-tree--SymbolTree+treeIterator) ⇒ <code>Object</code>
* [.index(child)](#module_symbol-tree--SymbolTree+index) ⇒ <code>Number</code>
Expand Down Expand Up @@ -217,7 +219,7 @@ Append all descendants of the given object to an array (in tree order).

<a name="module_symbol-tree--SymbolTree+childrenIterator"></a>
#### symbolTree.childrenIterator(parent) ⇒ <code>Object</code>
Iterate over all children of the given object to an array.
Iterate over all children of the given object

`O(1)` for a single iteration

Expand All @@ -228,6 +230,32 @@ Iterate over all children of the given object to an array.
| --- | --- |
| parent | <code>Object</code> |

<a name="module_symbol-tree--SymbolTree+prevSiblingsIterator"></a>
#### symbolTree.prevSiblingsIterator(object) ⇒ <code>Object</code>
Iterate over all the previous siblings of the given object. (in reverse tree order)

`O(1)` for a single iteration

**Kind**: instance method of <code>[SymbolTree](#exp_module_symbol-tree--SymbolTree)</code>
**Returns**: <code>Object</code> - An iterable iterator (ES6)

| Param | Type |
| --- | --- |
| object | <code>Object</code> |

<a name="module_symbol-tree--SymbolTree+nextSiblingsIterator"></a>
#### symbolTree.nextSiblingsIterator(object) ⇒ <code>Object</code>
Iterate over all the next siblings of the given object. (in tree order)

`O(1)` for a single iteration

**Kind**: instance method of <code>[SymbolTree](#exp_module_symbol-tree--SymbolTree)</code>
**Returns**: <code>Object</code> - An iterable iterator (ES6)

| Param | Type |
| --- | --- |
| object | <code>Object</code> |

<a name="module_symbol-tree--SymbolTree+ancestorsIterator"></a>
#### symbolTree.ancestorsIterator(object) ⇒ <code>Object</code>
Iterate over all inclusive ancestors of the given object
Expand Down

0 comments on commit 47308cf

Please sign in to comment.