add examples to the functions

201flaviosilva · Oct 17, 2022 · 06c75f5 · 06c75f5
1 parent 2c0e9f8
commit 06c75f5
Show file tree

Hide file tree

Showing 17 changed files with 39 additions and 286 deletions.
diff --git a/README.md b/README.md
@@ -42,7 +42,7 @@ console.log(randomNumber(1, 20));
 | `npm run bump`    | Update lib in the npm                                             |
 
 ## Links
-- [WebPage](https://201flaviosilva-labs.github.io/javascript-utils/);
+- [WebPage (Documentation)](https://201flaviosilva-labs.github.io/javascript-utils/);
 - [Package](https://www.npmjs.com/package/201flaviosilva-utils);
 - [GitHub](https://github.com/201flaviosilva-labs/javascript-utils);
   - [Wiki](https://github.com/201flaviosilva-labs/javascript-utils/wiki);
@@ -52,3 +52,4 @@ console.log(randomNumber(1, 20));
 
 ## Examples
 - [Code Sandbox](https://codesandbox.io/examples/package/201flaviosilva-utils);
+- [GitHub Repositories](https://github.com/201flaviosilva-labs/javascript-utils/network/dependents);
diff --git a/examples/js/DOM/KeyboardManager/index.html b/examples/js/DOM/KeyboardManager/index.html
diff --git a/examples/js/DOM/KeyboardManager/script.js b/examples/js/DOM/KeyboardManager/script.js
diff --git a/examples/js/DOM/MouseManager/index.html b/examples/js/DOM/MouseManager/index.html
diff --git a/examples/js/DOM/MouseManager/script.js b/examples/js/DOM/MouseManager/script.js
diff --git a/examples/js/Fibonacci/index.js b/examples/js/Fibonacci/index.js
diff --git a/examples/js/FullScreen/index.html b/examples/js/FullScreen/index.html
diff --git a/examples/js/FullScreen/script.js b/examples/js/FullScreen/script.js
diff --git a/examples/js/TopDownCarMovimentation/index.html b/examples/js/TopDownCarMovimentation/index.html
diff --git a/examples/js/TopDownCarMovimentation/script.js b/examples/js/TopDownCarMovimentation/script.js
diff --git a/examples/js/_test.js b/examples/js/_test.js
diff --git a/examples/js/index.html b/examples/js/index.html
diff --git a/src/DOM/KeyboardManager.js b/src/DOM/KeyboardManager.js
@@ -61,6 +61,13 @@ export const KEYS = {
  * const { left } = DOM.KeyboardManagerInstance.keys;
  * if (DOM.KeyboardManagerInstance.isKeyPressed(left)) console.log("Left");
  * 
+ * @example
+ * import { DOM } from "201flaviosilva-labs";
+ * const { KEYS, KeyboardManager, KeyboardManagerInstance } = DOM;
+ * setInterval(() => console.log(KeyboardManagerInstance.isKeyPressed(KEYS.a)), 100);
+ * KeyboardManagerInstance.events.on("keyDown-left", () => console.log("down-left"));
+ * KeyboardManagerInstance.events.on("keyUp-up", () => console.log(`up-${KEYS.up}`));
+ * 
  * @memberof DOM
  */
 export class KeyboardManager {

diff --git a/src/DOM/MouseManager.js b/src/DOM/MouseManager.js
@@ -18,6 +18,16 @@ export const MouseButton = {
  * const mouse = new DOM.MouseManager();
  * const { x, y } = mouse;
  * console.log(x, y);
+ * 
+ * @example
+ * import { DOM } from "201flaviosilva-labs";
+ * const { MouseManager, MouseManagerInstance, MouseButton, } = DOM
+ * const beepDiv = document.getElementById("MyDiv");
+ * const mouse = new MouseManager(true);
+ * setInterval(() => console.log(mouse.getPosition(beepDiv)), 1000);
+ * MouseManagerInstance.events.on("buttonDown-left", () => console.log("down -> left"));
+ * MouseManagerInstance.events.on("buttonDown-right", () => console.log("up -> right"));
+
  * 
  * @param {Boolean} [preventDefault=false] - Prevent the Default behavior on press right button
  * @memberof DOM

diff --git a/src/DOM/toggleFullScreen.js b/src/DOM/toggleFullScreen.js
@@ -4,6 +4,19 @@
  * 
  * @example toggleFullScreen();
  * @example toggleFullScreen(document.getElementById("myElement"));
+ * @example
+ * ```html
+ * <!--- html --->
+ * <button id="toggle">Toggle</button>
+ * ```
+ * 
+ * ```js
+ * // js
+ * import { toggleFullScreen } from "201flaviosilva-utils";
+ * document.getElementById("toggle").addEventListener("click", () => {
+ * 	toggleFullScreen(document.getElementById("toggle"));
+ * });
+ * ```
  * 
  * @param {HTMLElement} element - the DOM element to put in full screen
  * @returns {void}

diff --git a/src/Fibonacci.js b/src/Fibonacci.js
@@ -7,6 +7,11 @@
  * @see {@link https://pt.wikipedia.org/wiki/Sequ%C3%AAncia_de_Fibonacci}
  * 
  * @example new Fibonacci();
+ * @example
+ *	import { Fibonacci } from "201flaviosilva-utils";
+ *	const f = new Fibonacci();
+ *	for (i = 0; i < 10; i++) console.log(f.next()); // 1,2,3,5,8,13,21,34,55,89
+ *	for (i = 0; i < 5; i++) console.log(f.before()); // 55,34,21,13,8
  * 
  * @constructor
  */

diff --git a/src/topDownCarMovimentation.js b/src/topDownCarMovimentation.js
@@ -6,6 +6,8 @@ import { clamp } from "./clamp.js";
  * Algorithm based in {@link https://www.youtube.com/watch?v=Rs_rAxEsAvI}
  * @see {@link https://www.youtube.com/watch?v=Rs_rAxEsAvI}
  * 
+ * @see example -> {@link https://codesandbox.io/s/top-down-car-movimentation-sobjn0?file=/src/index.js}
+ * 
  * @param {Object} state - the current state of the car
  * @param {Object} state.keys - the objet with the input keys
  * @param {boolean} [state.keys.forward=false] true if the forward key is pressed