Skip to content

Commit f7e86e1

Browse files
author
Minggang Wang
committed
Update the docs based on the latest documentation comments
Fix #NONE
1 parent ff5f154 commit f7e86e1

33 files changed

+186
-88
lines changed

‎docs/Client.html‎

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

408408
<footer>
409-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Nov 16 2018 10:28:17 GMT+0800 (China Standard Time)
409+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jan 04 2019 10:19:18 GMT+0800 (China Standard Time)
410410
</footer>
411411

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

‎docs/Clock.html‎

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

410410
<footer>
411-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Nov 16 2018 10:28:17 GMT+0800 (China Standard Time)
411+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jan 04 2019 10:19:18 GMT+0800 (China Standard Time)
412412
</footer>
413413

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

‎docs/Duration.html‎

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

13341334
<footer>
1335-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Nov 16 2018 10:28:17 GMT+0800 (China Standard Time)
1335+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jan 04 2019 10:19:18 GMT+0800 (China Standard Time)
13361336
</footer>
13371337

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

‎docs/Logging.html‎

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

15721572
<footer>
1573-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Nov 16 2018 10:28:17 GMT+0800 (China Standard Time)
1573+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jan 04 2019 10:19:18 GMT+0800 (China Standard Time)
15741574
</footer>
15751575

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

‎docs/Node.html‎

Lines changed: 36 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -362,7 +362,7 @@ <h6>Properties</h6>
362362

363363
<dt class="tag-source">Source:</dt>
364364
<dd class="tag-source"><ul class="dummy"><li>
365-
<a href="lib_node.js.html">lib/node.js</a>, <a href="lib_node.js.html#line247">line 247</a>
365+
<a href="lib_node.js.html">lib/node.js</a>, <a href="lib_node.js.html#line248">line 248</a>
366366
</li></ul></dd>
367367

368368

@@ -645,7 +645,7 @@ <h6>Properties</h6>
645645

646646
<dt class="tag-source">Source:</dt>
647647
<dd class="tag-source"><ul class="dummy"><li>
648-
<a href="lib_node.js.html">lib/node.js</a>, <a href="lib_node.js.html#line174">line 174</a>
648+
<a href="lib_node.js.html">lib/node.js</a>, <a href="lib_node.js.html#line175">line 175</a>
649649
</li></ul></dd>
650650

651651

@@ -951,7 +951,7 @@ <h6>Properties</h6>
951951

952952
<dt class="tag-source">Source:</dt>
953953
<dd class="tag-source"><ul class="dummy"><li>
954-
<a href="lib_node.js.html">lib/node.js</a>, <a href="lib_node.js.html#line292">line 292</a>
954+
<a href="lib_node.js.html">lib/node.js</a>, <a href="lib_node.js.html#line293">line 293</a>
955955
</li></ul></dd>
956956

957957

@@ -1264,7 +1264,7 @@ <h6>Properties</h6>
12641264

12651265
<dt class="tag-source">Source:</dt>
12661266
<dd class="tag-source"><ul class="dummy"><li>
1267-
<a href="lib_node.js.html">lib/node.js</a>, <a href="lib_node.js.html#line213">line 213</a>
1267+
<a href="lib_node.js.html">lib/node.js</a>, <a href="lib_node.js.html#line214">line 214</a>
12681268
</li></ul></dd>
12691269

12701270

@@ -1327,7 +1327,7 @@ <h5>Returns:</h5>
13271327

13281328

13291329

1330-
<h4 class="name" id="createTimer"><span class="type-signature"></span>createTimer<span class="signature">(period, callback)</span><span class="type-signature"> &rarr; {<a href="Timer.html">Timer</a>}</span></h4>
1330+
<h4 class="name" id="createTimer"><span class="type-signature"></span>createTimer<span class="signature">(period, callback, context)</span><span class="type-signature"> &rarr; {<a href="Timer.html">Timer</a>}</span></h4>
13311331

13321332

13331333

@@ -1414,6 +1414,29 @@ <h5>Parameters:</h5>
14141414
</tr>
14151415

14161416

1417+
1418+
<tr>
1419+
1420+
<td class="name"><code>context</code></td>
1421+
1422+
1423+
<td class="type">
1424+
1425+
1426+
<span class="param-type">Context</span>
1427+
1428+
1429+
1430+
</td>
1431+
1432+
1433+
1434+
1435+
1436+
<td class="description last">The context, default is Context.defaultContext().</td>
1437+
</tr>
1438+
1439+
14171440
</tbody>
14181441
</table>
14191442

@@ -1451,7 +1474,7 @@ <h5>Parameters:</h5>
14511474

14521475
<dt class="tag-source">Source:</dt>
14531476
<dd class="tag-source"><ul class="dummy"><li>
1454-
<a href="lib_node.js.html">lib/node.js</a>, <a href="lib_node.js.html#line141">line 141</a>
1477+
<a href="lib_node.js.html">lib/node.js</a>, <a href="lib_node.js.html#line142">line 142</a>
14551478
</li></ul></dd>
14561479

14571480

@@ -1561,7 +1584,7 @@ <h4 class="name" id="destroy"><span class="type-signature"></span>destroy<span c
15611584

15621585
<dt class="tag-source">Source:</dt>
15631586
<dd class="tag-source"><ul class="dummy"><li>
1564-
<a href="lib_node.js.html">lib/node.js</a>, <a href="lib_node.js.html#line321">line 321</a>
1587+
<a href="lib_node.js.html">lib/node.js</a>, <a href="lib_node.js.html#line322">line 322</a>
15651588
</li></ul></dd>
15661589

15671590

@@ -1714,7 +1737,7 @@ <h5>Parameters:</h5>
17141737

17151738
<dt class="tag-source">Source:</dt>
17161739
<dd class="tag-source"><ul class="dummy"><li>
1717-
<a href="lib_node.js.html">lib/node.js</a>, <a href="lib_node.js.html#line363">line 363</a>
1740+
<a href="lib_node.js.html">lib/node.js</a>, <a href="lib_node.js.html#line364">line 364</a>
17181741
</li></ul></dd>
17191742

17201743

@@ -1867,7 +1890,7 @@ <h5>Parameters:</h5>
18671890

18681891
<dt class="tag-source">Source:</dt>
18691892
<dd class="tag-source"><ul class="dummy"><li>
1870-
<a href="lib_node.js.html">lib/node.js</a>, <a href="lib_node.js.html#line339">line 339</a>
1893+
<a href="lib_node.js.html">lib/node.js</a>, <a href="lib_node.js.html#line340">line 340</a>
18711894
</li></ul></dd>
18721895

18731896

@@ -2020,7 +2043,7 @@ <h5>Parameters:</h5>
20202043

20212044
<dt class="tag-source">Source:</dt>
20222045
<dd class="tag-source"><ul class="dummy"><li>
2023-
<a href="lib_node.js.html">lib/node.js</a>, <a href="lib_node.js.html#line375">line 375</a>
2046+
<a href="lib_node.js.html">lib/node.js</a>, <a href="lib_node.js.html#line376">line 376</a>
20242047
</li></ul></dd>
20252048

20262049

@@ -2173,7 +2196,7 @@ <h5>Parameters:</h5>
21732196

21742197
<dt class="tag-source">Source:</dt>
21752198
<dd class="tag-source"><ul class="dummy"><li>
2176-
<a href="lib_node.js.html">lib/node.js</a>, <a href="lib_node.js.html#line351">line 351</a>
2199+
<a href="lib_node.js.html">lib/node.js</a>, <a href="lib_node.js.html#line352">line 352</a>
21772200
</li></ul></dd>
21782201

21792202

@@ -2326,7 +2349,7 @@ <h5>Parameters:</h5>
23262349

23272350
<dt class="tag-source">Source:</dt>
23282351
<dd class="tag-source"><ul class="dummy"><li>
2329-
<a href="lib_node.js.html">lib/node.js</a>, <a href="lib_node.js.html#line387">line 387</a>
2352+
<a href="lib_node.js.html">lib/node.js</a>, <a href="lib_node.js.html#line388">line 388</a>
23302353
</li></ul></dd>
23312354

23322355

@@ -2394,7 +2417,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-rc
23942417
<br class="clear">
23952418

23962419
<footer>
2397-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Nov 16 2018 10:28:17 GMT+0800 (China Standard Time)
2420+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jan 04 2019 10:19:18 GMT+0800 (China Standard Time)
23982421
</footer>
23992422

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

‎docs/Publisher.html‎

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

378378
<footer>
379-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Nov 16 2018 10:28:17 GMT+0800 (China Standard Time)
379+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jan 04 2019 10:19:18 GMT+0800 (China Standard Time)
380380
</footer>
381381

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

‎docs/QoS.html‎

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

26132613
<footer>
2614-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Nov 16 2018 10:28:17 GMT+0800 (China Standard Time)
2614+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jan 04 2019 10:19:18 GMT+0800 (China Standard Time)
26152615
</footer>
26162616

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

‎docs/ROSClock.html‎

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

581581
<footer>
582-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Nov 16 2018 10:28:17 GMT+0800 (China Standard Time)
582+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jan 04 2019 10:19:18 GMT+0800 (China Standard Time)
583583
</footer>
584584

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

‎docs/Response.html‎

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

314314
<footer>
315-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Nov 16 2018 10:28:17 GMT+0800 (China Standard Time)
315+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jan 04 2019 10:19:18 GMT+0800 (China Standard Time)
316316
</footer>
317317

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

‎docs/Service.html‎

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

221221
<footer>
222-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Nov 16 2018 10:28:17 GMT+0800 (China Standard Time)
222+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jan 04 2019 10:19:18 GMT+0800 (China Standard Time)
223223
</footer>
224224

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

0 commit comments

Comments
 (0)