Skip to content

Commit 9cf90f4

Browse files
igorMSoaresigorMSoares
committed
docs: update documentation
1 parent 97609b1 commit 9cf90f4

14 files changed

+58
-53
lines changed

‎jsdoc/doc/animate.js.html

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,8 @@ <h1 class="page-title">Source: animate.js</h1>
6565
widthTransition: undefined,
6666
heightTransition: undefined,
6767
overflowHidden: true,
68+
stopPropagation: true,
69+
preventDefault: true,
6870
}),
6971
};
7072

@@ -73,7 +75,7 @@ <h1 class="page-title">Source: animate.js</h1>
7375
* if an option is not customized by the user, the default value set
7476
* in 'configurations.default' will be returned instead.
7577
* @see {@link CONFIG}
76-
* @see {@link module:animate~configurations}
78+
* @see {@link configurations}
7779
*/
7880
const configHandler = {
7981
/**
@@ -99,7 +101,7 @@ <h1 class="page-title">Source: animate.js</h1>
99101
* Object that handles configurations, either customized by the user
100102
* or default values defined in 'configurations.default' object
101103
* @type {Object.&lt;string,any>}
102-
* @see {@link module:animate~configurations}
104+
* @see {@link configurations}
103105
*/
104106
const CONFIG = new Proxy(configurations, configHandler);
105107

@@ -598,7 +600,10 @@ <h1 class="page-title">Source: animate.js</h1>
598600
*/
599601
const eventHandler = (el, animationId, opts) => {
600602
return (/** @type {Event} */ e) => {
601-
const { stopPropagation = true, preventDefault = true } = opts;
603+
const {
604+
stopPropagation = CONFIG.stopPropagation,
605+
preventDefault = CONFIG.preventDefault,
606+
} = opts;
602607
if (stopPropagation) e.stopPropagation();
603608
if (preventDefault) e.preventDefault();
604609

@@ -682,7 +687,7 @@ <h2><a href="index.html">JS-CSS Animations</a></h2><h3>Modules</h3><ul><li><a hr
682687
<br class="clear">
683688

684689
<footer>
685-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.0</a> on Wed Nov 23 2022 17:51:28 GMT-0300 (Horário Padrão de Brasília)
690+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.0</a> on Wed Nov 23 2022 20:22:20 GMT-0300 (Horário Padrão de Brasília)
686691
</footer>
687692

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

‎jsdoc/doc/globals.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ <h2><a href="index.html">JS-CSS Animations</a></h2><h3>Modules</h3><ul><li><a hr
193193
<br class="clear">
194194

195195
<footer>
196-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.0</a> on Wed Nov 23 2022 17:51:28 GMT-0300 (Horário Padrão de Brasília)
196+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.0</a> on Wed Nov 23 2022 20:22:20 GMT-0300 (Horário Padrão de Brasília)
197197
</footer>
198198

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

‎jsdoc/doc/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ <h2><a href="index.html">JS-CSS Animations</a></h2><h3>Modules</h3><ul><li><a hr
5656
<br class="clear">
5757

5858
<footer>
59-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.0</a> on Wed Nov 23 2022 17:51:28 GMT-0300 (Horário Padrão de Brasília)
59+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.0</a> on Wed Nov 23 2022 20:22:20 GMT-0300 (Horário Padrão de Brasília)
6060
</footer>
6161

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

‎jsdoc/doc/js-css-animations.js.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -285,7 +285,7 @@ <h1 class="page-title">Source: js-css-animations.js</h1>
285285
* Verifies if an element is out of its original orientation or scale.
286286
*
287287
* Note that if the element has CSS property 'transform: rotate(0deg)',
288-
* checkTransform() will still return False, as the element is not
288+
* isTransformed() will still return False, as the element is not
289289
* out of its original orientation.
290290
* @param {HTMLElement|string} selector - An element or a valid CSS selector corresponding to the element
291291
* @returns True if the element was rotated from its original orientation. False if it maintains the original orientation.
@@ -403,7 +403,7 @@ <h2><a href="index.html">JS-CSS Animations</a></h2><h3>Modules</h3><ul><li><a hr
403403
<br class="clear">
404404

405405
<footer>
406-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.0</a> on Wed Nov 23 2022 17:51:28 GMT-0300 (Horário Padrão de Brasília)
406+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.0</a> on Wed Nov 23 2022 20:22:20 GMT-0300 (Horário Padrão de Brasília)
407407
</footer>
408408

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

‎jsdoc/doc/measurements.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -273,7 +273,7 @@ <h2><a href="index.html">JS-CSS Animations</a></h2><h3>Modules</h3><ul><li><a hr
273273
<br class="clear">
274274

275275
<footer>
276-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.0</a> on Wed Nov 23 2022 17:51:28 GMT-0300 (Horário Padrão de Brasília)
276+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.0</a> on Wed Nov 23 2022 20:22:20 GMT-0300 (Horário Padrão de Brasília)
277277
</footer>
278278

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

‎jsdoc/doc/module-animate.html

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ <h4 class="name" id=".removeCustomCssProperties"><span class="type-signature">(s
146146

147147
<dt class="tag-source">Source:</dt>
148148
<dd class="tag-source"><ul class="dummy"><li>
149-
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line151">line 151</a>
149+
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line153">line 153</a>
150150
</li></ul></dd>
151151

152152

@@ -208,7 +208,7 @@ <h4 class="name" id=".setCssProperty"><span class="type-signature">(static, cons
208208

209209
<dt class="tag-source">Source:</dt>
210210
<dd class="tag-source"><ul class="dummy"><li>
211-
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line189">line 189</a>
211+
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line191">line 191</a>
212212
</li></ul></dd>
213213

214214

@@ -290,7 +290,7 @@ <h5>Type:</h5>
290290

291291
<dt class="tag-source">Source:</dt>
292292
<dd class="tag-source"><ul class="dummy"><li>
293-
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line93">line 93</a>
293+
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line95">line 95</a>
294294
</li></ul></dd>
295295

296296

@@ -363,7 +363,7 @@ <h5>Type:</h5>
363363

364364
<dt class="tag-source">Source:</dt>
365365
<dd class="tag-source"><ul class="dummy"><li>
366-
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line76">line 76</a>
366+
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line78">line 78</a>
367367
</li></ul></dd>
368368

369369

@@ -373,7 +373,7 @@ <h5>Type:</h5>
373373
<dt class="tag-see">See:</dt>
374374
<dd class="tag-see">
375375
<ul>
376-
<li><a href="module-animate.html#~configurations"><code>module:animate~configurations</code></a></li>
376+
<li><code>configurations</code></li>
377377
</ul>
378378
</dd>
379379

@@ -432,7 +432,7 @@ <h4 class="name" id="~DURATION_REGEX"><span class="type-signature">(inner, const
432432

433433
<dt class="tag-source">Source:</dt>
434434
<dd class="tag-source"><ul class="dummy"><li>
435-
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line79">line 79</a>
435+
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line81">line 81</a>
436436
</li></ul></dd>
437437

438438

@@ -506,7 +506,7 @@ <h5>Type:</h5>
506506

507507
<dt class="tag-source">Source:</dt>
508508
<dd class="tag-source"><ul class="dummy"><li>
509-
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line117">line 117</a>
509+
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line119">line 119</a>
510510
</li></ul></dd>
511511

512512

@@ -570,7 +570,7 @@ <h4 class="name" id="~configHandler"><span class="type-signature">(inner, consta
570570

571571
<dt class="tag-source">Source:</dt>
572572
<dd class="tag-source"><ul class="dummy"><li>
573-
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line50">line 50</a>
573+
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line52">line 52</a>
574574
</li></ul></dd>
575575

576576

@@ -582,7 +582,7 @@ <h4 class="name" id="~configHandler"><span class="type-signature">(inner, consta
582582
<ul>
583583
<li><code>CONFIG</code></li>
584584

585-
<li><a href="module-animate.html#~configurations"><code>module:animate~configurations</code></a></li>
585+
<li><code>configurations</code></li>
586586
</ul>
587587
</dd>
588588

@@ -715,7 +715,7 @@ <h4 class="name" id="~trigger"><span class="type-signature">(inner) </span>trigg
715715

716716
<dt class="tag-source">Source:</dt>
717717
<dd class="tag-source"><ul class="dummy"><li>
718-
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line236">line 236</a>
718+
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line238">line 238</a>
719719
</li></ul></dd>
720720

721721

@@ -913,7 +913,7 @@ <h5>Parameters:</h5>
913913

914914
<dt class="tag-source">Source:</dt>
915915
<dd class="tag-source"><ul class="dummy"><li>
916-
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line407">line 407</a>
916+
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line409">line 409</a>
917917
</li></ul></dd>
918918

919919

@@ -1060,7 +1060,7 @@ <h5>Parameters:</h5>
10601060

10611061
<dt class="tag-source">Source:</dt>
10621062
<dd class="tag-source"><ul class="dummy"><li>
1063-
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line300">line 300</a>
1063+
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line302">line 302</a>
10641064
</li></ul></dd>
10651065

10661066

@@ -1197,7 +1197,7 @@ <h5>Parameters:</h5>
11971197

11981198
<dt class="tag-source">Source:</dt>
11991199
<dd class="tag-source"><ul class="dummy"><li>
1200-
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line308">line 308</a>
1200+
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line310">line 310</a>
12011201
</li></ul></dd>
12021202

12031203

@@ -1358,7 +1358,7 @@ <h5>Parameters:</h5>
13581358

13591359
<dt class="tag-source">Source:</dt>
13601360
<dd class="tag-source"><ul class="dummy"><li>
1361-
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line364">line 364</a>
1361+
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line366">line 366</a>
13621362
</li></ul></dd>
13631363

13641364

@@ -1541,7 +1541,7 @@ <h5>Parameters:</h5>
15411541

15421542
<dt class="tag-source">Source:</dt>
15431543
<dd class="tag-source"><ul class="dummy"><li>
1544-
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line571">line 571</a>
1544+
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line573">line 573</a>
15451545
</li></ul></dd>
15461546

15471547

@@ -1720,7 +1720,7 @@ <h5>Parameters:</h5>
17201720

17211721
<dt class="tag-source">Source:</dt>
17221722
<dd class="tag-source"><ul class="dummy"><li>
1723-
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line520">line 520</a>
1723+
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line522">line 522</a>
17241724
</li></ul></dd>
17251725

17261726

@@ -1871,7 +1871,7 @@ <h5>Parameters:</h5>
18711871

18721872
<dt class="tag-source">Source:</dt>
18731873
<dd class="tag-source"><ul class="dummy"><li>
1874-
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line231">line 231</a>
1874+
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line233">line 233</a>
18751875
</li></ul></dd>
18761876

18771877

@@ -2018,7 +2018,7 @@ <h5>Parameters:</h5>
20182018

20192019
<dt class="tag-source">Source:</dt>
20202020
<dd class="tag-source"><ul class="dummy"><li>
2021-
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line249">line 249</a>
2021+
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line251">line 251</a>
20222022
</li></ul></dd>
20232023

20242024

@@ -2165,7 +2165,7 @@ <h5>Parameters:</h5>
21652165

21662166
<dt class="tag-source">Source:</dt>
21672167
<dd class="tag-source"><ul class="dummy"><li>
2168-
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line261">line 261</a>
2168+
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line263">line 263</a>
21692169
</li></ul></dd>
21702170

21712171

@@ -2336,7 +2336,7 @@ <h5>Parameters:</h5>
23362336

23372337
<dt class="tag-source">Source:</dt>
23382338
<dd class="tag-source"><ul class="dummy"><li>
2339-
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line347">line 347</a>
2339+
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line349">line 349</a>
23402340
</li></ul></dd>
23412341

23422342

@@ -2473,7 +2473,7 @@ <h5>Parameters:</h5>
24732473

24742474
<dt class="tag-source">Source:</dt>
24752475
<dd class="tag-source"><ul class="dummy"><li>
2476-
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line325">line 325</a>
2476+
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line327">line 327</a>
24772477
</li></ul></dd>
24782478

24792479

@@ -2620,7 +2620,7 @@ <h5>Parameters:</h5>
26202620

26212621
<dt class="tag-source">Source:</dt>
26222622
<dd class="tag-source"><ul class="dummy"><li>
2623-
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line99">line 99</a>
2623+
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line101">line 101</a>
26242624
</li></ul></dd>
26252625

26262626

@@ -2819,7 +2819,7 @@ <h5>Parameters:</h5>
28192819

28202820
<dt class="tag-source">Source:</dt>
28212821
<dd class="tag-source"><ul class="dummy"><li>
2822-
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line600">line 600</a>
2822+
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line605">line 605</a>
28232823
</li></ul></dd>
28242824

28252825

@@ -3012,7 +3012,7 @@ <h5>Parameters:</h5>
30123012

30133013
<dt class="tag-source">Source:</dt>
30143014
<dd class="tag-source"><ul class="dummy"><li>
3015-
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line381">line 381</a>
3015+
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line383">line 383</a>
30163016
</li></ul></dd>
30173017

30183018

@@ -3149,7 +3149,7 @@ <h5>Parameters:</h5>
31493149

31503150
<dt class="tag-source">Source:</dt>
31513151
<dd class="tag-source"><ul class="dummy"><li>
3152-
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line317">line 317</a>
3152+
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line319">line 319</a>
31533153
</li></ul></dd>
31543154

31553155

@@ -3296,7 +3296,7 @@ <h5>Parameters:</h5>
32963296

32973297
<dt class="tag-source">Source:</dt>
32983298
<dd class="tag-source"><ul class="dummy"><li>
3299-
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line282">line 282</a>
3299+
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line284">line 284</a>
33003300
</li></ul></dd>
33013301

33023302

@@ -3443,7 +3443,7 @@ <h5>Parameters:</h5>
34433443

34443444
<dt class="tag-source">Source:</dt>
34453445
<dd class="tag-source"><ul class="dummy"><li>
3446-
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line276">line 276</a>
3446+
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line278">line 278</a>
34473447
</li></ul></dd>
34483448

34493449

@@ -3614,7 +3614,7 @@ <h5>Parameters:</h5>
36143614

36153615
<dt class="tag-source">Source:</dt>
36163616
<dd class="tag-source"><ul class="dummy"><li>
3617-
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line541">line 541</a>
3617+
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line543">line 543</a>
36183618
</li></ul></dd>
36193619

36203620

@@ -3751,7 +3751,7 @@ <h5>Parameters:</h5>
37513751

37523752
<dt class="tag-source">Source:</dt>
37533753
<dd class="tag-source"><ul class="dummy"><li>
3754-
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line106">line 106</a>
3754+
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line108">line 108</a>
37553755
</li></ul></dd>
37563756

37573757

@@ -3888,7 +3888,7 @@ <h5>Parameters:</h5>
38883888

38893889
<dt class="tag-source">Source:</dt>
38903890
<dd class="tag-source"><ul class="dummy"><li>
3891-
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line288">line 288</a>
3891+
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line290">line 290</a>
38923892
</li></ul></dd>
38933893

38943894

@@ -3977,7 +3977,7 @@ <h4 class="name" id="~resetDefaultConfig"><span class="type-signature">(inner) <
39773977

39783978
<dt class="tag-source">Source:</dt>
39793979
<dd class="tag-source"><ul class="dummy"><li>
3980-
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line176">line 176</a>
3980+
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line178">line 178</a>
39813981
</li></ul></dd>
39823982

39833983

@@ -4144,7 +4144,7 @@ <h5>Parameters:</h5>
41444144

41454145
<dt class="tag-source">Source:</dt>
41464146
<dd class="tag-source"><ul class="dummy"><li>
4147-
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line198">line 198</a>
4147+
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line200">line 200</a>
41484148
</li></ul></dd>
41494149

41504150

@@ -4282,7 +4282,7 @@ <h5>Parameters:</h5>
42824282

42834283
<dt class="tag-source">Source:</dt>
42844284
<dd class="tag-source"><ul class="dummy"><li>
4285-
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line163">line 163</a>
4285+
<a href="animate.js.html">animate.js</a>, <a href="animate.js.html#line165">line 165</a>
42864286
</li></ul></dd>
42874287

42884288

@@ -4341,7 +4341,7 @@ <h2><a href="index.html">JS-CSS Animations</a></h2><h3>Modules</h3><ul><li><a hr
43414341
<br class="clear">
43424342

43434343
<footer>
4344-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.0</a> on Wed Nov 23 2022 17:51:28 GMT-0300 (Horário Padrão de Brasília)
4344+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.0</a> on Wed Nov 23 2022 20:22:20 GMT-0300 (Horário Padrão de Brasília)
43454345
</footer>
43464346

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

0 commit comments

Comments
 (0)