chore(frontend-docs): fix warnings & update

This commit is contained in:
Elian Doran
2024-12-11 18:31:29 +02:00
parent 1fa2758464
commit 6bbff3efd8
21 changed files with 2070 additions and 169 deletions

View File

@@ -95,7 +95,7 @@ For information on using widgets, see the tutorial widget_basics.</div>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="widgets_basic_widget.js.html">widgets/basic_widget.js</a>, <a href="widgets_basic_widget.js.html#line9">line 9</a>
<a href="widgets_basic_widget.js.html">widgets/basic_widget.js</a>, <a href="widgets_basic_widget.js.html#line11">line 11</a>
</li></ul></dd>
@@ -151,6 +151,176 @@ For information on using widgets, see the tutorial widget_basics.</div>
<h4 class="name" id="css"><span class="type-signature"></span>css<span class="signature">(name, value)</span><span class="type-signature"></span></h4>
<div class="description">
Sets the CSS attribute of the given name to the given value.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">the name of the CSS attribute to set (e.g. `padding-left`).</td>
</tr>
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">the value of the CSS attribute to set (e.g. `12px`).</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="widgets_basic_widget.js.html">widgets/basic_widget.js</a>, <a href="widgets_basic_widget.js.html#line75">line 75</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
self for chaining.
</div>
<h4 class="name" id="cssBlock"><span class="type-signature"></span>cssBlock<span class="signature">(block)</span><span class="type-signature"> &rarr; {this}</span></h4>
@@ -252,7 +422,7 @@ For information on using widgets, see the tutorial widget_basics.</div>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="widgets_basic_widget.js.html">widgets/basic_widget.js</a>, <a href="widgets_basic_widget.js.html#line78">line 78</a>
<a href="widgets_basic_widget.js.html">widgets/basic_widget.js</a>, <a href="widgets_basic_widget.js.html#line118">line 118</a>
</li></ul></dd>
@@ -365,7 +535,7 @@ The method is expected to create a this.$widget containing jQuery object
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="widgets_basic_widget.js.html">widgets/basic_widget.js</a>, <a href="widgets_basic_widget.js.html#line132">line 132</a>
<a href="widgets_basic_widget.js.html">widgets/basic_widget.js</a>, <a href="widgets_basic_widget.js.html#line209">line 209</a>
</li></ul></dd>
@@ -395,6 +565,487 @@ The method is expected to create a this.$widget containing jQuery object
<h4 class="name" id="isEnabled"><span class="type-signature"></span>isEnabled<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Indicates if the widget is enabled. Widgets are enabled by default. Generally setting this to `false` will cause the widget not to be displayed, however it will still be available on the DOM but hidden.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="widgets_basic_widget.js.html">widgets/basic_widget.js</a>, <a href="widgets_basic_widget.js.html#line199">line 199</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
whether the widget is enabled.
</div>
<h4 class="name" id="optChild"><span class="type-signature"></span>optChild<span class="signature">(condition, &hellip;components)</span><span class="type-signature"></span></h4>
<div class="description">
Conditionally adds the given components as children to this component.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>condition</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
</td>
<td class="description last">whether to add the components.</td>
</tr>
<tr>
<td class="name"><code>components</code></td>
<td class="type">
<span class="param-type">any</span>
</td>
<td class="attributes">
&lt;repeatable><br>
</td>
<td class="description last">the components to be added as children to this component provided the condition is truthy.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="widgets_basic_widget.js.html">widgets/basic_widget.js</a>, <a href="widgets_basic_widget.js.html#line50">line 50</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
self for chaining.
</div>
<h4 class="name" id="optCss"><span class="type-signature"></span>optCss<span class="signature">(condition, name, value)</span><span class="type-signature"></span></h4>
<div class="description">
Sets the CSS attribute of the given name to the given value, but only if the condition provided is truthy.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>condition</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">`true` in order to apply the CSS, `false` to ignore it.</td>
</tr>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">the name of the CSS attribute to set (e.g. `padding-left`).</td>
</tr>
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">the value of the CSS attribute to set (e.g. `12px`).</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="widgets_basic_widget.js.html">widgets/basic_widget.js</a>, <a href="widgets_basic_widget.js.html#line88">line 88</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
self for chaining.
</div>
@@ -417,7 +1068,7 @@ The method is expected to create a this.$widget containing jQuery object
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.3</a>
</footer>
<script> prettyPrint(); </script>