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

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

View file

@ -215,6 +215,568 @@
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="chatHandler"><span class="type-signature"></span>chatHandler<span class="type-signature"></span></h4>
<div class="description">
Parent Chat Handler
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_tokebot.js.html">app/channel/tokebot.js</a>, <a href="app_channel_tokebot.js.html#line41">line 41</a>
</li></ul></dd>
</dl>
<h4 class="name" id="cooldownCounter"><span class="type-signature"></span>cooldownCounter<span class="type-signature"></span></h4>
<div class="description">
Cooldown Counter
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_tokebot.js.html">app/channel/tokebot.js</a>, <a href="app_channel_tokebot.js.html#line71">line 71</a>
</li></ul></dd>
</dl>
<h4 class="name" id="cooldownTime"><span class="type-signature"></span>cooldownTime<span class="type-signature"></span></h4>
<div class="description">
Cooldown Time
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_tokebot.js.html">app/channel/tokebot.js</a>, <a href="app_channel_tokebot.js.html#line61">line 61</a>
</li></ul></dd>
</dl>
<h4 class="name" id="cooldownTimer"><span class="type-signature"></span>cooldownTimer<span class="type-signature"></span></h4>
<div class="description">
Cooldown Timer
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_tokebot.js.html">app/channel/tokebot.js</a>, <a href="app_channel_tokebot.js.html#line51">line 51</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_tokebot.js.html">app/channel/tokebot.js</a>, <a href="app_channel_tokebot.js.html#line36">line 36</a>
</li></ul></dd>
</dl>
<h4 class="name" id="tokeCounter"><span class="type-signature"></span>tokeCounter<span class="type-signature"></span></h4>
<div class="description">
Toke Counter
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_tokebot.js.html">app/channel/tokebot.js</a>, <a href="app_channel_tokebot.js.html#line66">line 66</a>
</li></ul></dd>
</dl>
<h4 class="name" id="tokeTime"><span class="type-signature"></span>tokeTime<span class="type-signature"></span></h4>
<div class="description">
Toke time
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_tokebot.js.html">app/channel/tokebot.js</a>, <a href="app_channel_tokebot.js.html#line56">line 56</a>
</li></ul></dd>
</dl>
<h4 class="name" id="tokeTimer"><span class="type-signature"></span>tokeTimer<span class="type-signature"></span></h4>
<div class="description">
Toke Timer
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_tokebot.js.html">app/channel/tokebot.js</a>, <a href="app_channel_tokebot.js.html#line46">line 46</a>
</li></ul></dd>
</dl>
<h4 class="name" id="tokers"><span class="type-signature"></span>tokers<span class="type-signature"></span></h4>
<div class="description">
List of current tokers
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_tokebot.js.html">app/channel/tokebot.js</a>, <a href="app_channel_tokebot.js.html#line76">line 76</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
@ -278,7 +840,7 @@ I would now, but I don't want to break shit in a comment-only commit.
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_tokebot.js.html">app/channel/tokebot.js</a>, <a href="app_channel_tokebot.js.html#line194">line 194</a>
<a href="app_channel_tokebot.js.html">app/channel/tokebot.js</a>, <a href="app_channel_tokebot.js.html#line220">line 220</a>
</li></ul></dd>
@ -366,7 +928,7 @@ I would now, but I don't want to break shit in a comment-only commit.
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_tokebot.js.html">app/channel/tokebot.js</a>, <a href="app_channel_tokebot.js.html#line205">line 205</a>
<a href="app_channel_tokebot.js.html">app/channel/tokebot.js</a>, <a href="app_channel_tokebot.js.html#line231">line 231</a>
</li></ul></dd>
@ -454,7 +1016,7 @@ I would now, but I don't want to break shit in a comment-only commit.
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_tokebot.js.html">app/channel/tokebot.js</a>, <a href="app_channel_tokebot.js.html#line148">line 148</a>
<a href="app_channel_tokebot.js.html">app/channel/tokebot.js</a>, <a href="app_channel_tokebot.js.html#line174">line 174</a>
</li></ul></dd>
@ -542,7 +1104,7 @@ I would now, but I don't want to break shit in a comment-only commit.
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_tokebot.js.html">app/channel/tokebot.js</a>, <a href="app_channel_tokebot.js.html#line59">line 59</a>
<a href="app_channel_tokebot.js.html">app/channel/tokebot.js</a>, <a href="app_channel_tokebot.js.html#line85">line 85</a>
</li></ul></dd>
@ -630,7 +1192,7 @@ I would now, but I don't want to break shit in a comment-only commit.
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_tokebot.js.html">app/channel/tokebot.js</a>, <a href="app_channel_tokebot.js.html#line222">line 222</a>
<a href="app_channel_tokebot.js.html">app/channel/tokebot.js</a>, <a href="app_channel_tokebot.js.html#line248">line 248</a>
</li></ul></dd>
@ -767,7 +1329,7 @@ I would now, but I don't want to break shit in a comment-only commit.
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_tokebot.js.html">app/channel/tokebot.js</a>, <a href="app_channel_tokebot.js.html#line69">line 69</a>
<a href="app_channel_tokebot.js.html">app/channel/tokebot.js</a>, <a href="app_channel_tokebot.js.html#line95">line 95</a>
</li></ul></dd>
@ -841,7 +1403,7 @@ I would now, but I don't want to break shit in a comment-only commit.
<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>