rainbownapkin/canopy
1
0
Fork 0
Code Issues 5 Pull requests Projects Releases Packages Wiki Activity Actions

Added JSDoc for Class Members of src/app/channel/*

Browse source
This commit is contained in:
rainbow napkin 2025-09-06 00:32:37 -04:00
parent 1aa836ba48
commit f34ad4829c
110 changed files with 6072 additions and 317 deletions
Download patch file Download diff file Expand all files Collapse all files

230
www/doc/server/chatHandler.html
View file

@ -192,6 +192,196 @@
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="chatBufferSize"><span class="type-signature"></span>chatBufferSize<span class="type-signature"></span></h4>
<div class="description">
Max chat buffer message count
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_chatHandler.js.html">app/channel/chatHandler.js</a>, <a href="app_channel_chatHandler.js.html#line50">line 50</a>
</li></ul></dd>
</dl>
<h4 class="name" id="commandPreprocessor"><span class="type-signature"></span>commandPreprocessor<span class="type-signature"></span></h4>
<div class="description">
Child Command Pre-Processor Object
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_chatHandler.js.html">app/channel/chatHandler.js</a>, <a href="app_channel_chatHandler.js.html#line45">line 45</a>
</li></ul></dd>
</dl>
<h4 class="name" id="server"><span class="type-signature"></span>server<span class="type-signature"></span></h4>
<div class="description">
Parent Server Object
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_chatHandler.js.html">app/channel/chatHandler.js</a>, <a href="app_channel_chatHandler.js.html#line40">line 40</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
@ -326,7 +516,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_chatHandler.js.html">app/channel/chatHandler.js</a>, <a href="app_channel_chatHandler.js.html#line123">line 123</a>
<a href="app_channel_chatHandler.js.html">app/channel/chatHandler.js</a>, <a href="app_channel_chatHandler.js.html#line131">line 131</a>
</li></ul></dd>
@ -486,7 +676,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_chatHandler.js.html">app/channel/chatHandler.js</a>, <a href="app_channel_chatHandler.js.html#line320">line 320</a>
<a href="app_channel_chatHandler.js.html">app/channel/chatHandler.js</a>, <a href="app_channel_chatHandler.js.html#line328">line 328</a>
</li></ul></dd>
@ -623,7 +813,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_chatHandler.js.html">app/channel/chatHandler.js</a>, <a href="app_channel_chatHandler.js.html#line49">line 49</a>
<a href="app_channel_chatHandler.js.html">app/channel/chatHandler.js</a>, <a href="app_channel_chatHandler.js.html#line57">line 57</a>
</li></ul></dd>
@ -783,7 +973,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_chatHandler.js.html">app/channel/chatHandler.js</a>, <a href="app_channel_chatHandler.js.html#line158">line 158</a>
<a href="app_channel_chatHandler.js.html">app/channel/chatHandler.js</a>, <a href="app_channel_chatHandler.js.html#line166">line 166</a>
</li></ul></dd>
@ -943,7 +1133,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_chatHandler.js.html">app/channel/chatHandler.js</a>, <a href="app_channel_chatHandler.js.html#line62">line 62</a>
<a href="app_channel_chatHandler.js.html">app/channel/chatHandler.js</a>, <a href="app_channel_chatHandler.js.html#line70">line 70</a>
</li></ul></dd>
@ -1103,7 +1293,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_chatHandler.js.html">app/channel/chatHandler.js</a>, <a href="app_channel_chatHandler.js.html#line305">line 305</a>
<a href="app_channel_chatHandler.js.html">app/channel/chatHandler.js</a>, <a href="app_channel_chatHandler.js.html#line313">line 313</a>
</li></ul></dd>
@ -1410,7 +1600,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_chatHandler.js.html">app/channel/chatHandler.js</a>, <a href="app_channel_chatHandler.js.html#line179">line 179</a>
<a href="app_channel_chatHandler.js.html">app/channel/chatHandler.js</a>, <a href="app_channel_chatHandler.js.html#line187">line 187</a>
</li></ul></dd>
@ -1570,7 +1760,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_chatHandler.js.html">app/channel/chatHandler.js</a>, <a href="app_channel_chatHandler.js.html#line188">line 188</a>
<a href="app_channel_chatHandler.js.html">app/channel/chatHandler.js</a>, <a href="app_channel_chatHandler.js.html#line196">line 196</a>
</li></ul></dd>
@ -1850,7 +2040,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_chatHandler.js.html">app/channel/chatHandler.js</a>, <a href="app_channel_chatHandler.js.html#line237">line 237</a>
<a href="app_channel_chatHandler.js.html">app/channel/chatHandler.js</a>, <a href="app_channel_chatHandler.js.html#line245">line 245</a>
</li></ul></dd>
@ -1987,7 +2177,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_chatHandler.js.html">app/channel/chatHandler.js</a>, <a href="app_channel_chatHandler.js.html#line245">line 245</a>
<a href="app_channel_chatHandler.js.html">app/channel/chatHandler.js</a>, <a href="app_channel_chatHandler.js.html#line253">line 253</a>
</li></ul></dd>
@ -2147,7 +2337,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_chatHandler.js.html">app/channel/chatHandler.js</a>, <a href="app_channel_chatHandler.js.html#line286">line 286</a>
<a href="app_channel_chatHandler.js.html">app/channel/chatHandler.js</a>, <a href="app_channel_chatHandler.js.html#line294">line 294</a>
</li></ul></dd>
@ -2445,7 +2635,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_chatHandler.js.html">app/channel/chatHandler.js</a>, <a href="app_channel_chatHandler.js.html#line215">line 215</a>
<a href="app_channel_chatHandler.js.html">app/channel/chatHandler.js</a>, <a href="app_channel_chatHandler.js.html#line223">line 223</a>
</li></ul></dd>
@ -2605,7 +2795,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_chatHandler.js.html">app/channel/chatHandler.js</a>, <a href="app_channel_chatHandler.js.html#line224">line 224</a>
<a href="app_channel_chatHandler.js.html">app/channel/chatHandler.js</a>, <a href="app_channel_chatHandler.js.html#line232">line 232</a>
</li></ul></dd>
@ -2765,7 +2955,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_chatHandler.js.html">app/channel/chatHandler.js</a>, <a href="app_channel_chatHandler.js.html#line296">line 296</a>
<a href="app_channel_chatHandler.js.html">app/channel/chatHandler.js</a>, <a href="app_channel_chatHandler.js.html#line304">line 304</a>
</li></ul></dd>
@ -2925,7 +3115,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_chatHandler.js.html">app/channel/chatHandler.js</a>, <a href="app_channel_chatHandler.js.html#line268">line 268</a>
<a href="app_channel_chatHandler.js.html">app/channel/chatHandler.js</a>, <a href="app_channel_chatHandler.js.html#line276">line 276</a>
</li></ul></dd>
@ -3108,7 +3298,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_chatHandler.js.html">app/channel/chatHandler.js</a>, <a href="app_channel_chatHandler.js.html#line277">line 277</a>
<a href="app_channel_chatHandler.js.html">app/channel/chatHandler.js</a>, <a href="app_channel_chatHandler.js.html#line285">line 285</a>
</li></ul></dd>
@ -3314,7 +3504,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_chatHandler.js.html">app/channel/chatHandler.js</a>, <a href="app_channel_chatHandler.js.html#line257">line 257</a>
<a href="app_channel_chatHandler.js.html">app/channel/chatHandler.js</a>, <a href="app_channel_chatHandler.js.html#line265">line 265</a>
</li></ul></dd>
@ -3474,7 +3664,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_chatHandler.js.html">app/channel/chatHandler.js</a>, <a href="app_channel_chatHandler.js.html#line71">line 71</a>
<a href="app_channel_chatHandler.js.html">app/channel/chatHandler.js</a>, <a href="app_channel_chatHandler.js.html#line79">line 79</a>
</li></ul></dd>
@ -3634,7 +3824,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_chatHandler.js.html">app/channel/chatHandler.js</a>, <a href="app_channel_chatHandler.js.html#line95">line 95</a>
<a href="app_channel_chatHandler.js.html">app/channel/chatHandler.js</a>, <a href="app_channel_chatHandler.js.html#line103">line 103</a>
</li></ul></dd>
@ -3686,7 +3876,7 @@
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.4</a> on Fri Sep 05 2025 08:36:32 GMT-0400 (Eastern Daylight Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.4</a> on Sat Sep 06 2025 00:30:24 GMT-0400 (Eastern Daylight Time)
</footer>
<script> prettyPrint(); </script>