Mise à jour de la documentation

src/gsdom.js

@@ -90,6 +90,10 @@ window.$_ = (() => {
   };
   /**
    * Définit un attribut et sa valeur
+   * 
+   * @example
+   * $_("input.class").setAttr("readonly", "");
+   * 
    * @param {String} attr Nom de l'attribut
    * @param {String} value Valeur de l'attribut
    * @returns {this} Chainage
@@ -102,6 +106,10 @@ window.$_ = (() => {
   };
   /**
    * Supprime un attribut dans les éléments sélectionnés
+   * 
+   * @example
+   * $_(input.class).delAttr("readonly");
+   * 
    * @param {String} attr Nom de l'attribut à supprimer
    * @returns {this} Chainage
    */
@@ -113,6 +121,9 @@ window.$_ = (() => {
   };
   /**
    * Ajoute l'attribut hidden aux éléments sélectionnés
+   * 
+   * @example $_("span.class").setHidden();
+   * 
    * @returns {this} Chainage
    */
   Constructor.prototype.setHidden = function () {
@@ -121,6 +132,10 @@ window.$_ = (() => {
   };
   /**
    * Ajoute l'attribut readonly aux éléments sélectionnés
+   * 
+   * @example
+   * $_("input.class").setReadOnly();
+   * 
    * @returns {this} Chainage
    */
   Constructor.prototype.setReadOnly = function () {
@@ -129,6 +144,10 @@ window.$_ = (() => {
   };
   /**
    * Ajoute l'attribut disabled aux éléments sélectionnés
+   * 
+   * @example
+   * $_("input.class").setDisabled();
+   * 
    * @returns {this} Chainage
    */
   Constructor.prototype.setDisabled = function () {
@@ -137,6 +156,10 @@ window.$_ = (() => {
   };
   /**
    * Supprime l'attribut hidden aux éléments sélectionnés
+   * 
+   * @example
+   * $_("span.class").delHidden();
+   * 
    * @returns {this} Chainage
    */
   Constructor.prototype.delHidden = function () {
@@ -145,6 +168,10 @@ window.$_ = (() => {
   };
   /**
    * Supprime l'attribut readonly aux éléments sélectionnés
+   * 
+   * @example
+   * $_("input.class").delReadOnly();
+   * 
    * @returns {this} Chainage
    */
   Constructor.prototype.delReadOnly = function () {
@@ -153,6 +180,10 @@ window.$_ = (() => {
   };
   /**
    * Supprime l'attribut disabled aux éléments sélectionnés
+   * 
+   * @example
+   * $_("input.class").delDisabled();
+   * 
    * @returns {this} Chainage
    */
   Constructor.prototype.delDisabled = function () {
@@ -161,6 +192,10 @@ window.$_ = (() => {
   };
   /**
    * switche l'attribut hidden des éléments sélectionnés
+   * 
+   * @example
+   * $_("span.class").toggleHidden();
+   * 
    * @returns {this} Chainage
    */
   Constructor.prototype.toggleHidden = function () {
@@ -175,6 +210,10 @@ window.$_ = (() => {
   };
   /**
    * switche l'attribut readonly des éléments sélectionnés
+   * 
+   * @example
+   * $_("input.class").toggleReadOnly();
+   * 
    * @returns {this} Chainage
    */
   Constructor.prototype.toggleReadOnly = function () {
@@ -189,6 +228,10 @@ window.$_ = (() => {
   };
   /**
    * switche l'attribut disabled des éléments sélectionnés
+   * 
+   * @example
+   * $_("input.class").toggleDisabled();
+   * 
    * @returns {this} Chainage
    */
   Constructor.prototype.toggleDisabled = function () {
@@ -203,6 +246,12 @@ window.$_ = (() => {
   };
   /**
    * Ajout d'un gestionnaire d'événement aux éléments sélectionnés
+   * 
+   * @example 
+   * $_("button#event").on("mouseover", (evt, el) => {
+   *  // Do something with evt and el
+   * }, false);
+   * 
    * @param {String} type Nom de l'événement
    * @param {Function} callback Gestionnaire de l'événement
    * @param {Boolean} useCapture Propagation de l'événement
@@ -218,6 +267,12 @@ window.$_ = (() => {
   };
   /**
    * Ajout d'un gestionnaire d'événement 'click' pour les éléments sélectionnés
+   * 
+   * @example 
+   * $_("button#event").onClick( (evt, el) => {
+   *  // Do something with evt and el
+   * }, false);
+   * 
    * @param {Function} callback Gestionnaire de l'événement
    * @param {Boolean} useCapture Propagation de l'événement
    */
@@ -227,6 +282,10 @@ window.$_ = (() => {
   };
   /**
    * Retourne si un élément a été trouvé
+   * 
+   * @example
+   * let found = $_("#main").found();
+   * 
    * @returns {Boolean} l'élément du DOM trouvé
    */
   Constructor.prototype.found = function () {
@@ -234,6 +293,10 @@ window.$_ = (() => {
   };
   /**
    * Retourne le premier élément trouvé
+   * 
+   * @example
+   * let htmlElement = $_("p.paragraphe").first();
+   * 
    * @returns {HTMLElement} l'élément du DOM trouvé
    */
   Constructor.prototype.first = function () {
@@ -241,6 +304,10 @@ window.$_ = (() => {
   };
   /**
    * Retourne le dernier élément trouvé
+   * 
+   * @example
+   * let htmlElement = $_("p.paragraphe").last();
+   * 
    * @returns {HTMLElement} L'élément du DOM trouvé
    */
   Constructor.prototype.last = function () {
@@ -248,6 +315,9 @@ window.$_ = (() => {
   };
   /**
    * Instantiation d'un nouveau constructeur
+   * 
+   * @internal
+   * 
    * @param {String} selector Sélecteur utilisé
    * @param {HTMLElement} scope Racine de la recherche
    */