Improve jsdoc

Author: Joris-van-der-Wel

lib/SymbolTree.js

@@ -1,26 +1,32 @@
 'use strict';
 
-const SymbolTreeNode = require('./SymbolTreeNode');
-
 /**
  * @module symbol-tree
  * @author Joris van der Wel <joris@jorisvanderwel.com>
  */
 
-/**
- * @param [description='SymbolTree data'] Description used for the Symbol
- * @constructor
- * @alias module:symbol-tree
- */
-module.exports = class SymbolTree {
+const SymbolTreeNode = require('./SymbolTreeNode');
+
+class SymbolTree {
+
+        /**
+         * @constructor
+         * @alias module:symbol-tree
+         * @param [description='SymbolTree data'] Description used for the Symbol
+         */
         constructor(description) {
                 this.symbol = Symbol(description || 'SymbolTree data');
         }
 
         /**
          * You can optionally initialize an object after its creation,
-         * to take advantage of V8's fast properties
-         * @method initialize
+         * to take advantage of V8's fast properties. Also useful if you would like to
+         * freeze your object.
+         *
+         * `O(1)`
+         *
+         * @method
+         * @alias module:symbol-tree#initialize
          * @param {Object} object
          * @return {Object} object
          */
@@ -46,8 +52,11 @@ module.exports = class SymbolTree {
 
         /**
          * Returns true if the object has any children.
+         *
          * `O(1)`
+         *
          * @method isEmpty
+         * @memberOf module:symbol-tree#
          * @param {Object} object
          * @return {Boolean}
          */
@@ -57,8 +66,11 @@ module.exports = class SymbolTree {
 
         /**
          * Return the first child of the given object.
+         *
          * `O(1)`
+         *
          * @method first
+         * @memberOf module:symbol-tree#
          * @param {Object} object
          * @return {Object}
          */
@@ -68,8 +80,11 @@ module.exports = class SymbolTree {
 
         /**
          * Return the last child of the given object.
+         *
          * `O(1)`
+         *
          * @method last
+         * @memberOf module:symbol-tree#
          * @param {Object} object
          * @return {Object}
          */
@@ -79,8 +94,11 @@ module.exports = class SymbolTree {
 
         /**
          * Return the previous sibling of the given object.
+         *
          * `O(1)`
+         *
          * @method prev
+         * @memberOf module:symbol-tree#
          * @param {Object} object
          * @return {Object}
          */
@@ -90,8 +108,11 @@ module.exports = class SymbolTree {
 
         /**
          * Return the next sibling of the given object.
+         *
          * `O(1)`
+         *
          * @method next
+         * @memberOf module:symbol-tree#
          * @param {Object} object
          * @return {Object}
          */
@@ -101,8 +122,11 @@ module.exports = class SymbolTree {
 
         /**
          * Return the parent of the given object.
+         *
          * `O(1)`
+         *
          * @method parent
+         * @memberOf module:symbol-tree#
          * @param {Object} object
          * @return {Object}
          */
@@ -116,6 +140,7 @@ module.exports = class SymbolTree {
          * `O(n)` (worst case)
          *
          * @method lastInclusiveDescendant
+         * @memberOf module:symbol-tree#
          * @param {Object} object
          * @return {Object}
          */
@@ -128,10 +153,16 @@ module.exports = class SymbolTree {
 
                 return object;
         }
+
+        /**
          * 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.
+         *
+         * `O(n)` (worst case)
+         *
          * @method preceding
+         * @memberOf module:symbol-tree#
          * @param {Object} object
          * @param {Object} [treeRoot] If set, `treeRoot` must be an inclusive ancestor
          *        of the return value (or else null is returned). This check _assumes_
@@ -157,7 +188,11 @@ module.exports = class SymbolTree {
          * 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.
+         *
+         * `O(n)` (worst case)
+         *
          * @method following
+         * @memberOf module:symbol-tree#
          * @param {!Object} object
          * @param {Object} [treeRoot] If set, `treeRoot` must be an inclusive ancestor
          *        of the return value (or else null is returned). This check _assumes_
@@ -194,9 +229,12 @@ module.exports = class SymbolTree {
 
         /**
          * Remove the object from this tree.
-         * `O(1)`
          * Has no effect if already removed.
+         *
+         * `O(1)`
+         *
          * @method remove
+         * @memberOf module:symbol-tree#
          * @param {Object} removeObject
          * @return {Object} removeObject
          */
@@ -233,10 +271,12 @@ module.exports = class SymbolTree {
 
         /**
          * Insert the given object before the reference object.
+         * `newObject` is now the previous sibling of `referenceObject`.
+         *
          * `O(1)`
-         * `newObject` is now the previous sibling of `referenceObject`
          *
          * @method insertBefore
+         * @memberOf module:symbol-tree#
          * @param {Object} newObject
          * @param {Object} referenceObject
          * @throws {Error} If the newObject is already present in this SymbolTree
@@ -270,10 +310,12 @@ module.exports = class SymbolTree {
 
         /**
          * Insert the given object after the reference object.
+         * `newObject` is now the next sibling of `referenceObject`.
+         *
          * `O(1)`
-         * `newObject` is now the next sibling of `referenceObject`
          *
          * @method insertAfter
+         * @memberOf module:symbol-tree#
          * @param {Object} newObject
          * @param {Object} referenceObject
          * @throws {Error} If the newObject is already present in this SymbolTree
@@ -307,10 +349,12 @@ module.exports = class SymbolTree {
 
         /**
          * Insert the given object as the first child of the given reference object.
+         * `newObject` is now the first child of `referenceObject`.
+         *
          * `O(1)`
-         * `newObject` is now the first child of `referenceObject`
          *
          * @method insertFirst
+         * @memberOf module:symbol-tree#
          * @param {Object} newObject
          * @param {Object} referenceObject
          * @throws {Error} If the newObject is already present in this SymbolTree
@@ -338,10 +382,12 @@ module.exports = class SymbolTree {
 
         /**
          * Insert the given object as the last child of the given reference object.
+         * `newObject` is now the last child of `referenceObject`.
+         *
          * `O(1)`
-         * `newObject` is now the last child of `referenceObject`
          *
          * @method insertLast
+         * @memberOf module:symbol-tree#
          * @param {Object} newObject
          * @param {Object} referenceObject
          * @throws {Error} If the newObject is already present in this SymbolTree
@@ -366,4 +412,6 @@ module.exports = class SymbolTree {
 
                 return newObject;
         }
-};
+}
+
+module.exports = SymbolTree;