childrenIterator: jsdoc

Author: Joris-van-der-Wel

lib/SymbolTree.js

@@ -303,6 +303,16 @@ class SymbolTree {
                 return array;
         }
 
+        /**
+         * Iterate over all children of the given object to an array.
+         *
+         * `O(1)` (per iterate step)
+         *
+         * @method childrenIterator
+         * @memberOf module:symbol-tree#
+         * @param {Object} parent
+         * @return {Object} An iterable iterator (ES6)
+         */
         childrenIterator(parent) {
                 const _node = this._node.bind(this);