Skip to content

Commit d732bb0

Browse files
committed
Documentation error
1 parent 121df17 commit d732bb0

11 files changed

+15
-15
lines changed

dist/Counter-browser.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1365,7 +1365,7 @@ var Counter = function () {
13651365
* Allocates a counter sequentially
13661366
* If a counter is specified, it will allocate it explicitly
13671367
* But it will skip over intermediate children, and subsequent allocations is still sequential
1368-
* @param {?number} counter
1368+
* @param {number} [counter]
13691369
* @returns {number|boolean}
13701370
* @throws {RangeError} - Will throw if the explicitly allocated counter is out of bounds
13711371
*/

dist/Counter.cjs.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -355,7 +355,7 @@ class Counter {
355355
* Allocates a counter sequentially
356356
* If a counter is specified, it will allocate it explicitly
357357
* But it will skip over intermediate children, and subsequent allocations is still sequential
358-
* @param {?number} counter
358+
* @param {number} [counter]
359359
* @returns {number|boolean}
360360
* @throws {RangeError} - Will throw if the explicitly allocated counter is out of bounds
361361
*/

dist/Counter.es.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -351,7 +351,7 @@ class Counter {
351351
* Allocates a counter sequentially
352352
* If a counter is specified, it will allocate it explicitly
353353
* But it will skip over intermediate children, and subsequent allocations is still sequential
354-
* @param {?number} counter
354+
* @param {number} [counter]
355355
* @returns {number|boolean}
356356
* @throws {RangeError} - Will throw if the explicitly allocated counter is out of bounds
357357
*/

doc/Counter.js.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -386,7 +386,7 @@ <h1 class="page-title">Source: Counter.js</h1>
386386
* Allocates a counter sequentially
387387
* If a counter is specified, it will allocate it explicitly
388388
* But it will skip over intermediate children, and subsequent allocations is still sequential
389-
* @param {?number} counter
389+
* @param {number} [counter]
390390
* @returns {number|boolean}
391391
* @throws {RangeError} - Will throw if the explicitly allocated counter is out of bounds
392392
*/
@@ -475,7 +475,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Co
475475
<br class="clear">
476476

477477
<footer>
478-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Thu Jan 25 2018 22:10:37 GMT+1100 (AEDT)
478+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Thu Jan 25 2018 22:14:29 GMT+1100 (AEDT)
479479
</footer>
480480

481481
<script> prettyPrint(); </script>

doc/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Co
5656
<br class="clear">
5757

5858
<footer>
59-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Thu Jan 25 2018 22:10:37 GMT+1100 (AEDT)
59+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Thu Jan 25 2018 22:14:29 GMT+1100 (AEDT)
6060
</footer>
6161

6262
<script> prettyPrint(); </script>

doc/module-Counter-BitMapTree.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Co
235235
<br class="clear">
236236

237237
<footer>
238-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Thu Jan 25 2018 22:10:37 GMT+1100 (AEDT)
238+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Thu Jan 25 2018 22:14:29 GMT+1100 (AEDT)
239239
</footer>
240240

241241
<script> prettyPrint(); </script>

doc/module-Counter-Counter.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -241,7 +241,7 @@ <h3 class="subsection-title">Methods</h3>
241241

242242

243243

244-
<h4 class="name" id="allocate"><span class="type-signature"></span>allocate<span class="signature">(counter<span class="signature-attributes">nullable</span>)</span><span class="type-signature"> &rarr; {number|boolean}</span></h4>
244+
<h4 class="name" id="allocate"><span class="type-signature"></span>allocate<span class="signature">(counter<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {number|boolean}</span></h4>
245245

246246

247247

@@ -303,9 +303,9 @@ <h5>Parameters:</h5>
303303

304304
<td class="attributes">
305305

306-
306+
&lt;optional><br>
307307

308-
&lt;nullable><br>
308+
309309

310310

311311

@@ -751,7 +751,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Co
751751
<br class="clear">
752752

753753
<footer>
754-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Thu Jan 25 2018 22:10:37 GMT+1100 (AEDT)
754+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Thu Jan 25 2018 22:14:29 GMT+1100 (AEDT)
755755
</footer>
756756

757757
<script> prettyPrint(); </script>

doc/module-Counter-Leaf.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -705,7 +705,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Co
705705
<br class="clear">
706706

707707
<footer>
708-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Thu Jan 25 2018 22:10:37 GMT+1100 (AEDT)
708+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Thu Jan 25 2018 22:14:29 GMT+1100 (AEDT)
709709
</footer>
710710

711711
<script> prettyPrint(); </script>

doc/module-Counter-Node.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -994,7 +994,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Co
994994
<br class="clear">
995995

996996
<footer>
997-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Thu Jan 25 2018 22:10:37 GMT+1100 (AEDT)
997+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Thu Jan 25 2018 22:14:29 GMT+1100 (AEDT)
998998
</footer>
999999

10001000
<script> prettyPrint(); </script>

doc/module-Counter.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -244,7 +244,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Co
244244
<br class="clear">
245245

246246
<footer>
247-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Thu Jan 25 2018 22:10:37 GMT+1100 (AEDT)
247+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Thu Jan 25 2018 22:14:29 GMT+1100 (AEDT)
248248
</footer>
249249

250250
<script> prettyPrint(); </script>

lib/Counter.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -358,7 +358,7 @@ class Counter {
358358
* Allocates a counter sequentially
359359
* If a counter is specified, it will allocate it explicitly
360360
* But it will skip over intermediate children, and subsequent allocations is still sequential
361-
* @param {?number} counter
361+
* @param {number} [counter]
362362
* @returns {number|boolean}
363363
* @throws {RangeError} - Will throw if the explicitly allocated counter is out of bounds
364364
*/

0 commit comments

Comments
 (0)