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

@ -307,6 +307,382 @@
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="flair"><span class="type-signature"></span>flair<span class="type-signature"></span></h4>
<div class="description">
Flair ID String for the flair used to send the message
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_chat.js.html">app/channel/chat.js</a>, <a href="app_channel_chat.js.html#line39">line 39</a>
</li></ul></dd>
</dl>
<h4 class="name" id="highLevel"><span class="type-signature"></span>highLevel<span class="type-signature"></span></h4>
<div class="description">
Number representing current high level
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_chat.js.html">app/channel/chat.js</a>, <a href="app_channel_chat.js.html#line44">line 44</a>
</li></ul></dd>
</dl>
<h4 class="name" id="links"><span class="type-signature"></span>links<span class="type-signature"></span></h4>
<div class="description">
Array of URLs/Links included in the message.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_chat.js.html">app/channel/chat.js</a>, <a href="app_channel_chat.js.html#line59">line 59</a>
</li></ul></dd>
</dl>
<h4 class="name" id="msg"><span class="type-signature"></span>msg<span class="type-signature"></span></h4>
<div class="description">
COntents of the message, with links replaced with numbered file-seperator marks
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_chat.js.html">app/channel/chat.js</a>, <a href="app_channel_chat.js.html#line49">line 49</a>
</li></ul></dd>
</dl>
<h4 class="name" id="type"><span class="type-signature"></span>type<span class="type-signature"></span></h4>
<div class="description">
Message Type Identifier, used for client-side processing.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_chat.js.html">app/channel/chat.js</a>, <a href="app_channel_chat.js.html#line54">line 54</a>
</li></ul></dd>
</dl>
<h4 class="name" id="user"><span class="type-signature"></span>user<span class="type-signature"></span></h4>
<div class="description">
User who sent the message
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_chat.js.html">app/channel/chat.js</a>, <a href="app_channel_chat.js.html#line34">line 34</a>
</li></ul></dd>
</dl>
@ -329,7 +705,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>