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

2025-09-06 00:32:37 -04:00 · 2025-09-06 00:32:37 -04:00 · f34ad4829c
commit f34ad4829c
parent 1aa836ba48
110 changed files with 6072 additions and 317 deletions
--- a/www/doc/server/activeChannel.html
+++ b/www/doc/server/activeChannel.html
@ -215,6 +215,444 @@
    

    
+        <h3 class="subsection-title">Members</h3>
+
+        
+            
+<h4 class="name" id="chatBuffer"><span class="type-signature"></span>chatBuffer<span class="type-signature"></span></h4>
+
+
+
+
+<div class="description">
+    Child Chat Buffer Object
+</div>
+
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="app_channel_activeChannel.js.html">app/channel/activeChannel.js</a>, <a href="app_channel_activeChannel.js.html#line68">line 68</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+        
+            
+<h4 class="name" id="name"><span class="type-signature"></span>name<span class="type-signature"></span></h4>
+
+
+
+
+<div class="description">
+    Current Channel Name
+</div>
+
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="app_channel_activeChannel.js.html">app/channel/activeChannel.js</a>, <a href="app_channel_activeChannel.js.html#line43">line 43</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+        
+            
+<h4 class="name" id="playlistHandler"><span class="type-signature"></span>playlistHandler<span class="type-signature"></span></h4>
+
+
+
+
+<div class="description">
+    Child Playlist Handler Object
+</div>
+
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="app_channel_activeChannel.js.html">app/channel/activeChannel.js</a>, <a href="app_channel_activeChannel.js.html#line63">line 63</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+        
+            
+<h4 class="name" id="queue"><span class="type-signature"></span>queue<span class="type-signature"></span></h4>
+
+
+
+
+<div class="description">
+    Child Queue Object
+</div>
+
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="app_channel_activeChannel.js.html">app/channel/activeChannel.js</a>, <a href="app_channel_activeChannel.js.html#line58">line 58</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_activeChannel.js.html">app/channel/activeChannel.js</a>, <a href="app_channel_activeChannel.js.html#line38">line 38</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+        
+            
+<h4 class="name" id="tokeCommands"><span class="type-signature"></span>tokeCommands<span class="type-signature"></span></h4>
+
+
+
+
+<div class="description">
+    List of channel-wide toke commands
+</div>
+
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="app_channel_activeChannel.js.html">app/channel/activeChannel.js</a>, <a href="app_channel_activeChannel.js.html#line48">line 48</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+        
+            
+<h4 class="name" id="userList"><span class="type-signature"></span>userList<span class="type-signature"></span></h4>
+
+
+
+
+<div class="description">
+    List of connected users
+</div>
+
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="app_channel_activeChannel.js.html">app/channel/activeChannel.js</a>, <a href="app_channel_activeChannel.js.html#line53">line 53</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+        
+    

    
        <h3 class="subsection-title">Methods</h3>
@ -326,7 +764,7 @@
    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="app_channel_activeChannel.js.html">app/channel/activeChannel.js</a>, <a href="app_channel_activeChannel.js.html#line140">line 140</a>
+        <a href="app_channel_activeChannel.js.html">app/channel/activeChannel.js</a>, <a href="app_channel_activeChannel.js.html#line165">line 165</a>
    </li></ul></dd>
    

@ -414,7 +852,7 @@
    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="app_channel_activeChannel.js.html">app/channel/activeChannel.js</a>, <a href="app_channel_activeChannel.js.html#line117">line 117</a>
+        <a href="app_channel_activeChannel.js.html">app/channel/activeChannel.js</a>, <a href="app_channel_activeChannel.js.html#line142">line 142</a>
    </li></ul></dd>
    

@ -597,7 +1035,7 @@
    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="app_channel_activeChannel.js.html">app/channel/activeChannel.js</a>, <a href="app_channel_activeChannel.js.html#line53">line 53</a>
+        <a href="app_channel_activeChannel.js.html">app/channel/activeChannel.js</a>, <a href="app_channel_activeChannel.js.html#line78">line 78</a>
    </li></ul></dd>
    

@ -734,7 +1172,7 @@
    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="app_channel_activeChannel.js.html">app/channel/activeChannel.js</a>, <a href="app_channel_activeChannel.js.html#line92">line 92</a>
+        <a href="app_channel_activeChannel.js.html">app/channel/activeChannel.js</a>, <a href="app_channel_activeChannel.js.html#line117">line 117</a>
    </li></ul></dd>
    

@ -786,7 +1224,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>