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

216
www/doc/server/channelManager.html
View file

@ -192,6 +192,196 @@
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="activeChannels"><span class="type-signature"></span>activeChannels<span class="type-signature"></span></h4>
<div class="description">
Map containing all active channels running on the server
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_channelManager.js.html">app/channel/channelManager.js</a>, <a href="app_channel_channelManager.js.html#line47">line 47</a>
</li></ul></dd>
</dl>
<h4 class="name" id="chatHandler"><span class="type-signature"></span>chatHandler<span class="type-signature"></span></h4>
<div class="description">
Global Chat Handler Object
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_channelManager.js.html">app/channel/channelManager.js</a>, <a href="app_channel_channelManager.js.html#line52">line 52</a>
</li></ul></dd>
</dl>
<h4 class="name" id="io"><span class="type-signature"></span>io<span class="type-signature"></span></h4>
<div class="description">
Socket.io server instance passed down from server.js
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_channelManager.js.html">app/channel/channelManager.js</a>, <a href="app_channel_channelManager.js.html#line42">line 42</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
@ -303,7 +493,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_channelManager.js.html">app/channel/channelManager.js</a>, <a href="app_channel_channelManager.js.html#line152">line 152</a>
<a href="app_channel_channelManager.js.html">app/channel/channelManager.js</a>, <a href="app_channel_channelManager.js.html#line157">line 157</a>
</li></ul></dd>
@ -413,7 +603,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_channelManager.js.html">app/channel/channelManager.js</a>, <a href="app_channel_channelManager.js.html#line297">line 297</a>
<a href="app_channel_channelManager.js.html">app/channel/channelManager.js</a>, <a href="app_channel_channelManager.js.html#line302">line 302</a>
</li></ul></dd>
@ -573,7 +763,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_channelManager.js.html">app/channel/channelManager.js</a>, <a href="app_channel_channelManager.js.html#line254">line 254</a>
<a href="app_channel_channelManager.js.html">app/channel/channelManager.js</a>, <a href="app_channel_channelManager.js.html#line259">line 259</a>
</li></ul></dd>
@ -710,7 +900,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_channelManager.js.html">app/channel/channelManager.js</a>, <a href="app_channel_channelManager.js.html#line200">line 200</a>
<a href="app_channel_channelManager.js.html">app/channel/channelManager.js</a>, <a href="app_channel_channelManager.js.html#line205">line 205</a>
</li></ul></dd>
@ -847,7 +1037,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_channelManager.js.html">app/channel/channelManager.js</a>, <a href="app_channel_channelManager.js.html#line174">line 174</a>
<a href="app_channel_channelManager.js.html">app/channel/channelManager.js</a>, <a href="app_channel_channelManager.js.html#line179">line 179</a>
</li></ul></dd>
@ -1006,7 +1196,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_channelManager.js.html">app/channel/channelManager.js</a>, <a href="app_channel_channelManager.js.html#line230">line 230</a>
<a href="app_channel_channelManager.js.html">app/channel/channelManager.js</a>, <a href="app_channel_channelManager.js.html#line235">line 235</a>
</li></ul></dd>
@ -1176,7 +1366,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_channelManager.js.html">app/channel/channelManager.js</a>, <a href="app_channel_channelManager.js.html#line272">line 272</a>
<a href="app_channel_channelManager.js.html">app/channel/channelManager.js</a>, <a href="app_channel_channelManager.js.html#line277">line 277</a>
</li></ul></dd>
@ -1313,7 +1503,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_channelManager.js.html">app/channel/channelManager.js</a>, <a href="app_channel_channelManager.js.html#line220">line 220</a>
<a href="app_channel_channelManager.js.html">app/channel/channelManager.js</a>, <a href="app_channel_channelManager.js.html#line225">line 225</a>
</li></ul></dd>
@ -1460,7 +1650,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_channelManager.js.html">app/channel/channelManager.js</a>, <a href="app_channel_channelManager.js.html#line57">line 57</a>
<a href="app_channel_channelManager.js.html">app/channel/channelManager.js</a>, <a href="app_channel_channelManager.js.html#line62">line 62</a>
</li></ul></dd>
@ -1620,7 +1810,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_channelManager.js.html">app/channel/channelManager.js</a>, <a href="app_channel_channelManager.js.html#line210">line 210</a>
<a href="app_channel_channelManager.js.html">app/channel/channelManager.js</a>, <a href="app_channel_channelManager.js.html#line215">line 215</a>
</li></ul></dd>
@ -1780,7 +1970,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_channelManager.js.html">app/channel/channelManager.js</a>, <a href="app_channel_channelManager.js.html#line289">line 289</a>
<a href="app_channel_channelManager.js.html">app/channel/channelManager.js</a>, <a href="app_channel_channelManager.js.html#line294">line 294</a>
</li></ul></dd>
@ -1917,7 +2107,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_channelManager.js.html">app/channel/channelManager.js</a>, <a href="app_channel_channelManager.js.html#line110">line 110</a>
<a href="app_channel_channelManager.js.html">app/channel/channelManager.js</a>, <a href="app_channel_channelManager.js.html#line115">line 115</a>
</li></ul></dd>
@ -1991,7 +2181,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>