Skip to content

Commit e900796

Browse files
MajoredMajored
committed
Update live & staged documentation
1 parent acfc6c8 commit e900796

76 files changed

Lines changed: 1940 additions & 516 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/live/APIError.html‎

Lines changed: 20 additions & 92 deletions
Original file line numberDiff line numberDiff line change
@@ -139,20 +139,12 @@ <h4 class="name" id="APIError"><span class="type-signature"></span>new APIError<
139139

140140

141141

142-
143-
144-
<h3 class="subsection-title">Methods</h3>
142+
<h3 class="subsection-title">Members</h3>
145143

146144

147145

146+
<h4 class="name" id="code"><span class="type-signature"></span>code<span class="type-signature"> :string</span></h4>
148147

149-
150-
151-
152-
<h4 class="name" id="code"><span class="type-signature"></span>code<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
153-
154-
155-
156148

157149

158150

@@ -162,11 +154,15 @@ <h4 class="name" id="code"><span class="type-signature"></span>code<span class="
162154

163155

164156

157+
<h5>Type:</h5>
158+
<ul>
159+
<li>
160+
161+
<span class="param-type">string</span>
165162

166163

167-
168-
169-
164+
</li>
165+
</ul>
170166

171167

172168

@@ -217,52 +213,10 @@ <h4 class="name" id="code"><span class="type-signature"></span>code<span class="
217213

218214

219215

220-
221-
222-
223-
224-
225-
226-
227-
228-
229-
<h5>Returns:</h5>
230-
231-
232-
<div class="param-desc">
233-
The machine-readable error code.
234-
</div>
235-
236-
237-
238-
<dl>
239-
<dt>
240-
Type
241-
</dt>
242-
<dd>
243-
244-
<span class="param-type">string</span>
245-
246-
247-
</dd>
248-
</dl>
249-
250-
251-
252-
253-
254-
255-
256216

257217

218+
<h4 class="name" id="message"><span class="type-signature"></span>message<span class="type-signature"> :string</span></h4>
258219

259-
260-
261-
262-
<h4 class="name" id="message"><span class="type-signature"></span>message<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
263-
264-
265-
266220

267221

268222

@@ -272,11 +226,15 @@ <h4 class="name" id="message"><span class="type-signature"></span>message<span c
272226

273227

274228

229+
<h5>Type:</h5>
230+
<ul>
231+
<li>
232+
233+
<span class="param-type">string</span>
275234

276235

277-
278-
279-
236+
</li>
237+
</ul>
280238

281239

282240

@@ -327,41 +285,11 @@ <h4 class="name" id="message"><span class="type-signature"></span>message<span c
327285

328286

329287

330-
331-
332-
333-
334-
335-
336-
337-
338-
339-
<h5>Returns:</h5>
340-
341-
342-
<div class="param-desc">
343-
The human-readable error message.
344-
</div>
345-
346-
347-
348-
<dl>
349-
<dt>
350-
Type
351-
</dt>
352-
<dd>
353288

354-
<span class="param-type">string</span>
355-
356-
357-
</dd>
358-
</dl>
359-
360289

361290

362-
363-
364-
291+
292+
<h3 class="subsection-title">Methods</h3>
365293

366294

367295

@@ -544,7 +472,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="APIError.
544472
<br class="clear">
545473

546474
<footer>
547-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Sat Mar 18 2023 12:05:22 GMT+0000 (Greenwich Mean Time)
475+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Feb 18 2025 13:19:45 GMT+0000 (Greenwich Mean Time)
548476
</footer>
549477

550478
<script> prettyPrint(); </script>

‎docs/live/APIError.js.html‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,17 +43,17 @@ <h1 class="page-title">Source: APIError.js</h1>
4343

4444
/** Returns the machine-readable code of the error.
4545
*
46-
* @returns {string} The machine-readable error code.
46+
* @type {string} The machine-readable error code.
4747
*/
48-
code() {
48+
get code() {
4949
return this.#code;
5050
}
5151

5252
/** Returns the human-readable message of the error.
5353
*
54-
* @returns {string} The human-readable error message.
54+
* @type {string} The human-readable error message.
5555
*/
56-
message() {
56+
get message() {
5757
return this.#message;
5858
}
5959

@@ -83,7 +83,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="APIError.
8383
<br class="clear">
8484

8585
<footer>
86-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Sat Mar 18 2023 12:05:22 GMT+0000 (Greenwich Mean Time)
86+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Feb 18 2025 13:19:45 GMT+0000 (Greenwich Mean Time)
8787
</footer>
8888

8989
<script> prettyPrint(); </script>

‎docs/live/AlertsHelper.html‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ <h4 class="name" id="AlertsHelper"><span class="type-signature"></span>new Alert
9393

9494
<dt class="tag-source">Source:</dt>
9595
<dd class="tag-source"><ul class="dummy"><li>
96-
<a href="helpers_AlertsHelper.js.html">helpers/AlertsHelper.js</a>, <a href="helpers_AlertsHelper.js.html#line14">line 14</a>
96+
<a href="helpers_AlertsHelper.js.html">helpers/AlertsHelper.js</a>, <a href="helpers_AlertsHelper.js.html#line16">line 16</a>
9797
</li></ul></dd>
9898

9999

@@ -253,7 +253,7 @@ <h5>Parameters:</h5>
253253

254254
<dt class="tag-source">Source:</dt>
255255
<dd class="tag-source"><ul class="dummy"><li>
256-
<a href="helpers_AlertsHelper.js.html">helpers/AlertsHelper.js</a>, <a href="helpers_AlertsHelper.js.html#line26">line 26</a>
256+
<a href="helpers_AlertsHelper.js.html">helpers/AlertsHelper.js</a>, <a href="helpers_AlertsHelper.js.html#line28">line 28</a>
257257
</li></ul></dd>
258258

259259

@@ -415,7 +415,7 @@ <h5>Parameters:</h5>
415415

416416
<dt class="tag-source">Source:</dt>
417417
<dd class="tag-source"><ul class="dummy"><li>
418-
<a href="helpers_AlertsHelper.js.html">helpers/AlertsHelper.js</a>, <a href="helpers_AlertsHelper.js.html#line35">line 35</a>
418+
<a href="helpers_AlertsHelper.js.html">helpers/AlertsHelper.js</a>, <a href="helpers_AlertsHelper.js.html#line37">line 37</a>
419419
</li></ul></dd>
420420

421421

@@ -600,7 +600,7 @@ <h5>Parameters:</h5>
600600

601601
<dt class="tag-source">Source:</dt>
602602
<dd class="tag-source"><ul class="dummy"><li>
603-
<a href="helpers_AlertsHelper.js.html">helpers/AlertsHelper.js</a>, <a href="helpers_AlertsHelper.js.html#line46">line 46</a>
603+
<a href="helpers_AlertsHelper.js.html">helpers/AlertsHelper.js</a>, <a href="helpers_AlertsHelper.js.html#line48">line 48</a>
604604
</li></ul></dd>
605605

606606

@@ -710,7 +710,7 @@ <h4 class="name" id="markAsRead"><span class="type-signature">(async) </span>mar
710710

711711
<dt class="tag-source">Source:</dt>
712712
<dd class="tag-source"><ul class="dummy"><li>
713-
<a href="helpers_AlertsHelper.js.html">helpers/AlertsHelper.js</a>, <a href="helpers_AlertsHelper.js.html#line51">line 51</a>
713+
<a href="helpers_AlertsHelper.js.html">helpers/AlertsHelper.js</a>, <a href="helpers_AlertsHelper.js.html#line53">line 53</a>
714714
</li></ul></dd>
715715

716716

@@ -762,7 +762,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="APIError.
762762
<br class="clear">
763763

764764
<footer>
765-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Sat Mar 18 2023 12:05:22 GMT+0000 (Greenwich Mean Time)
765+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Feb 18 2025 13:19:45 GMT+0000 (Greenwich Mean Time)
766766
</footer>
767767

768768
<script> prettyPrint(); </script>

‎docs/live/ConversationsHelper.html‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ <h4 class="name" id="ConversationsHelper"><span class="type-signature"></span>ne
9393

9494
<dt class="tag-source">Source:</dt>
9595
<dd class="tag-source"><ul class="dummy"><li>
96-
<a href="helpers_ConversationsHelper.js.html">helpers/ConversationsHelper.js</a>, <a href="helpers_ConversationsHelper.js.html#line26">line 26</a>
96+
<a href="helpers_ConversationsHelper.js.html">helpers/ConversationsHelper.js</a>, <a href="helpers_ConversationsHelper.js.html#line28">line 28</a>
9797
</li></ul></dd>
9898

9999

@@ -253,7 +253,7 @@ <h5>Parameters:</h5>
253253

254254
<dt class="tag-source">Source:</dt>
255255
<dd class="tag-source"><ul class="dummy"><li>
256-
<a href="helpers_ConversationsHelper.js.html">helpers/ConversationsHelper.js</a>, <a href="helpers_ConversationsHelper.js.html#line38">line 38</a>
256+
<a href="helpers_ConversationsHelper.js.html">helpers/ConversationsHelper.js</a>, <a href="helpers_ConversationsHelper.js.html#line40">line 40</a>
257257
</li></ul></dd>
258258

259259

@@ -415,7 +415,7 @@ <h5>Parameters:</h5>
415415

416416
<dt class="tag-source">Source:</dt>
417417
<dd class="tag-source"><ul class="dummy"><li>
418-
<a href="helpers_ConversationsHelper.js.html">helpers/ConversationsHelper.js</a>, <a href="helpers_ConversationsHelper.js.html#line47">line 47</a>
418+
<a href="helpers_ConversationsHelper.js.html">helpers/ConversationsHelper.js</a>, <a href="helpers_ConversationsHelper.js.html#line49">line 49</a>
419419
</li></ul></dd>
420420

421421

@@ -600,7 +600,7 @@ <h5>Parameters:</h5>
600600

601601
<dt class="tag-source">Source:</dt>
602602
<dd class="tag-source"><ul class="dummy"><li>
603-
<a href="helpers_ConversationsHelper.js.html">helpers/ConversationsHelper.js</a>, <a href="helpers_ConversationsHelper.js.html#line83">line 83</a>
603+
<a href="helpers_ConversationsHelper.js.html">helpers/ConversationsHelper.js</a>, <a href="helpers_ConversationsHelper.js.html#line85">line 85</a>
604604
</li></ul></dd>
605605

606606

@@ -785,7 +785,7 @@ <h5>Parameters:</h5>
785785

786786
<dt class="tag-source">Source:</dt>
787787
<dd class="tag-source"><ul class="dummy"><li>
788-
<a href="helpers_ConversationsHelper.js.html">helpers/ConversationsHelper.js</a>, <a href="helpers_ConversationsHelper.js.html#line94">line 94</a>
788+
<a href="helpers_ConversationsHelper.js.html">helpers/ConversationsHelper.js</a>, <a href="helpers_ConversationsHelper.js.html#line96">line 96</a>
789789
</li></ul></dd>
790790

791791

@@ -993,7 +993,7 @@ <h5>Parameters:</h5>
993993

994994
<dt class="tag-source">Source:</dt>
995995
<dd class="tag-source"><ul class="dummy"><li>
996-
<a href="helpers_ConversationsHelper.js.html">helpers/ConversationsHelper.js</a>, <a href="helpers_ConversationsHelper.js.html#line106">line 106</a>
996+
<a href="helpers_ConversationsHelper.js.html">helpers/ConversationsHelper.js</a>, <a href="helpers_ConversationsHelper.js.html#line108">line 108</a>
997997
</li></ul></dd>
998998

999999

@@ -1179,7 +1179,7 @@ <h5>Parameters:</h5>
11791179

11801180
<dt class="tag-source">Source:</dt>
11811181
<dd class="tag-source"><ul class="dummy"><li>
1182-
<a href="helpers_ConversationsHelper.js.html">helpers/ConversationsHelper.js</a>, <a href="helpers_ConversationsHelper.js.html#line59">line 59</a>
1182+
<a href="helpers_ConversationsHelper.js.html">helpers/ConversationsHelper.js</a>, <a href="helpers_ConversationsHelper.js.html#line61">line 61</a>
11831183
</li></ul></dd>
11841184

11851185

@@ -1361,7 +1361,7 @@ <h5>Parameters:</h5>
13611361

13621362
<dt class="tag-source">Source:</dt>
13631363
<dd class="tag-source"><ul class="dummy"><li>
1364-
<a href="helpers_ConversationsHelper.js.html">helpers/ConversationsHelper.js</a>, <a href="helpers_ConversationsHelper.js.html#line117">line 117</a>
1364+
<a href="helpers_ConversationsHelper.js.html">helpers/ConversationsHelper.js</a>, <a href="helpers_ConversationsHelper.js.html#line119">line 119</a>
13651365
</li></ul></dd>
13661366

13671367

@@ -1566,7 +1566,7 @@ <h5>Parameters:</h5>
15661566

15671567
<dt class="tag-source">Source:</dt>
15681568
<dd class="tag-source"><ul class="dummy"><li>
1569-
<a href="helpers_ConversationsHelper.js.html">helpers/ConversationsHelper.js</a>, <a href="helpers_ConversationsHelper.js.html#line71">line 71</a>
1569+
<a href="helpers_ConversationsHelper.js.html">helpers/ConversationsHelper.js</a>, <a href="helpers_ConversationsHelper.js.html#line73">line 73</a>
15701570
</li></ul></dd>
15711571

15721572

@@ -1640,7 +1640,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="APIError.
16401640
<br class="clear">
16411641

16421642
<footer>
1643-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Sat Mar 18 2023 12:05:22 GMT+0000 (Greenwich Mean Time)
1643+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Feb 18 2025 13:19:45 GMT+0000 (Greenwich Mean Time)
16441644
</footer>
16451645

16461646
<script> prettyPrint(); </script>

0 commit comments

Comments
 (0)