Skip to content

Commit 59acdc5

Browse files
Workaround for jsdoc's lack of ES6 support
1 parent 74ebd36 commit 59acdc5

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

lib/SymbolTree.js

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ module.exports = class SymbolTree {
2020
/**
2121
* You can optionally initialize an object after its creation,
2222
* to take advantage of V8's fast properties
23+
* @method initialize
2324
* @param {Object} object
2425
* @return {Object} object
2526
*/
@@ -46,6 +47,7 @@ module.exports = class SymbolTree {
4647
/**
4748
* Returns true if the object has any children.
4849
* `O(1)`
50+
* @method isEmpty
4951
* @param {Object} object
5052
* @return {Boolean}
5153
*/
@@ -56,6 +58,7 @@ module.exports = class SymbolTree {
5658
/**
5759
* Return the first child of the given object.
5860
* `O(1)`
61+
* @method first
5962
* @param {Object} object
6063
* @return {Object}
6164
*/
@@ -66,6 +69,7 @@ module.exports = class SymbolTree {
6669
/**
6770
* Return the last child of the given object.
6871
* `O(1)`
72+
* @method last
6973
* @param {Object} object
7074
* @return {Object}
7175
*/
@@ -76,6 +80,7 @@ module.exports = class SymbolTree {
7680
/**
7781
* Return the previous sibling of the given object.
7882
* `O(1)`
83+
* @method prev
7984
* @param {Object} object
8085
* @return {Object}
8186
*/
@@ -86,6 +91,7 @@ module.exports = class SymbolTree {
8691
/**
8792
* Return the next sibling of the given object.
8893
* `O(1)`
94+
* @method next
8995
* @param {Object} object
9096
* @return {Object}
9197
*/
@@ -96,6 +102,7 @@ module.exports = class SymbolTree {
96102
/**
97103
* Return the parent of the given object.
98104
* `O(1)`
105+
* @method parent
99106
* @param {Object} object
100107
* @return {Object}
101108
*/
@@ -107,6 +114,7 @@ module.exports = class SymbolTree {
107114
* Remove the object from this tree.
108115
* `O(1)`
109116
* Has no effect if already removed.
117+
* @method remove
110118
* @param {Object} removeObject
111119
* @return {Object} removeObject
112120
*/
@@ -146,6 +154,7 @@ module.exports = class SymbolTree {
146154
* `O(1)`
147155
* `newObject` is now the previous sibling of `referenceObject`
148156
*
157+
* @method insertBefore
149158
* @param {Object} newObject
150159
* @param {Object} referenceObject
151160
* @throws {Error} If the newObject is already present in this SymbolTree
@@ -182,6 +191,7 @@ module.exports = class SymbolTree {
182191
* `O(1)`
183192
* `newObject` is now the next sibling of `referenceObject`
184193
*
194+
* @method insertAfter
185195
* @param {Object} newObject
186196
* @param {Object} referenceObject
187197
* @throws {Error} If the newObject is already present in this SymbolTree
@@ -218,6 +228,7 @@ module.exports = class SymbolTree {
218228
* `O(1)`
219229
* `newObject` is now the first child of `referenceObject`
220230
*
231+
* @method insertFirst
221232
* @param {Object} newObject
222233
* @param {Object} referenceObject
223234
* @throws {Error} If the newObject is already present in this SymbolTree
@@ -248,6 +259,7 @@ module.exports = class SymbolTree {
248259
* `O(1)`
249260
* `newObject` is now the last child of `referenceObject`
250261
*
262+
* @method insertLast
251263
* @param {Object} newObject
252264
* @param {Object} referenceObject
253265
* @throws {Error} If the newObject is already present in this SymbolTree

0 commit comments

Comments
 (0)