add module be to doc

fabioricali · Jul 5, 2017 · 2be8c19 · 2be8c19
1 parent 65c3472
commit 2be8c19
Show file tree

Hide file tree

Showing 46 changed files with 3,885 additions and 213 deletions.
diff --git a/.jsdoc.json b/.jsdoc.json
@@ -4,7 +4,7 @@
         "dictionaries": ["jsdoc"]
     },
     "source": {
-        "include": ["./src/asserts", "package.json", "README.md"],
+        "include": ["./src/asserts", "./src/be.js", "package.json", "README.md"],
         "includePattern": ".js$",
         "excludePattern": "(node_modules/|docs)"
     },

diff --git a/docs/bejs/1.3.1/arrays.js.html b/docs/bejs/1.3.1/arrays.js.html
diff --git a/docs/bejs/1.3.1/asserts_arrays.js.html b/docs/bejs/1.3.1/asserts_arrays.js.html
diff --git a/docs/bejs/1.3.1/asserts_creditCards.js.html b/docs/bejs/1.3.1/asserts_creditCards.js.html
diff --git a/docs/bejs/1.3.1/asserts_dates.js.html b/docs/bejs/1.3.1/asserts_dates.js.html
diff --git a/docs/bejs/1.3.1/asserts_dom.js.html b/docs/bejs/1.3.1/asserts_dom.js.html
diff --git a/docs/bejs/1.3.1/asserts_envs.js.html b/docs/bejs/1.3.1/asserts_envs.js.html
diff --git a/docs/bejs/1.3.1/asserts_hashes.js.html b/docs/bejs/1.3.1/asserts_hashes.js.html
diff --git a/docs/bejs/1.3.1/asserts_mixed.js.html b/docs/bejs/1.3.1/asserts_mixed.js.html
diff --git a/docs/bejs/1.3.1/asserts_numbers.js.html b/docs/bejs/1.3.1/asserts_numbers.js.html
diff --git a/docs/bejs/1.3.1/asserts_objects.js.html b/docs/bejs/1.3.1/asserts_objects.js.html
diff --git a/docs/bejs/1.3.1/asserts_postalCodes.js.html b/docs/bejs/1.3.1/asserts_postalCodes.js.html
diff --git a/docs/bejs/1.3.1/asserts_strings.js.html b/docs/bejs/1.3.1/asserts_strings.js.html
diff --git a/docs/bejs/1.3.1/asserts_types.js.html b/docs/bejs/1.3.1/asserts_types.js.html
diff --git a/docs/bejs/1.3.1/asserts_urls.js.html b/docs/bejs/1.3.1/asserts_urls.js.html
diff --git a/docs/bejs/1.3.1/be.js.html b/docs/bejs/1.3.1/be.js.html
diff --git a/docs/bejs/1.3.1/creditCards.js.html b/docs/bejs/1.3.1/creditCards.js.html
diff --git a/docs/bejs/1.3.1/dates.js.html b/docs/bejs/1.3.1/dates.js.html
diff --git a/docs/bejs/1.3.1/dom.js.html b/docs/bejs/1.3.1/dom.js.html
diff --git a/docs/bejs/1.3.1/envs.js.html b/docs/bejs/1.3.1/envs.js.html
diff --git a/docs/bejs/1.3.1/hashes.js.html b/docs/bejs/1.3.1/hashes.js.html
diff --git a/docs/bejs/1.3.1/index.html b/docs/bejs/1.3.1/index.html
diff --git a/docs/bejs/1.3.1/mixed.js.html b/docs/bejs/1.3.1/mixed.js.html
diff --git a/docs/bejs/1.3.1/module-Array.html b/docs/bejs/1.3.1/module-Array.html
diff --git a/docs/bejs/1.3.1/module-DOM.html b/docs/bejs/1.3.1/module-DOM.html
diff --git a/docs/bejs/1.3.1/module-Dates.html b/docs/bejs/1.3.1/module-Dates.html
diff --git a/docs/bejs/1.3.1/module-Envs.html b/docs/bejs/1.3.1/module-Envs.html
diff --git a/docs/bejs/1.3.1/module-Hashes.html b/docs/bejs/1.3.1/module-Hashes.html
diff --git a/docs/bejs/1.3.1/module-Mixed.html b/docs/bejs/1.3.1/module-Mixed.html
diff --git a/docs/bejs/1.3.1/module-Numbers.html b/docs/bejs/1.3.1/module-Numbers.html
diff --git a/docs/bejs/1.3.1/module-Objects.html b/docs/bejs/1.3.1/module-Objects.html
diff --git a/docs/bejs/1.3.1/module-Strings.html b/docs/bejs/1.3.1/module-Strings.html
diff --git a/docs/bejs/1.3.1/module-Types.html b/docs/bejs/1.3.1/module-Types.html
diff --git a/docs/bejs/1.3.1/module-Urls.html b/docs/bejs/1.3.1/module-Urls.html
diff --git a/docs/bejs/1.3.1/module-creditCard.html b/docs/bejs/1.3.1/module-creditCard.html
diff --git a/docs/bejs/1.3.1/module-postalCodes.html b/docs/bejs/1.3.1/module-postalCodes.html
diff --git a/docs/bejs/1.3.1/numbers.js.html b/docs/bejs/1.3.1/numbers.js.html
diff --git a/docs/bejs/1.3.1/objects.js.html b/docs/bejs/1.3.1/objects.js.html
diff --git a/docs/bejs/1.3.1/postalCodes.js.html b/docs/bejs/1.3.1/postalCodes.js.html
diff --git a/docs/bejs/1.3.1/strings.js.html b/docs/bejs/1.3.1/strings.js.html
diff --git a/docs/bejs/1.3.1/types.js.html b/docs/bejs/1.3.1/types.js.html
diff --git a/docs/bejs/1.3.1/urls.js.html b/docs/bejs/1.3.1/urls.js.html
diff --git a/src/asserts/creditCards.js b/src/asserts/creditCards.js
@@ -1,6 +1,6 @@
 /**
  * @fileOverview Credit cards checks.
- * @module creditCard
+ * @module CreditCard
  */
 
 const Interface = require('../interface');

diff --git a/src/asserts/postalCodes.js b/src/asserts/postalCodes.js
@@ -1,6 +1,6 @@
 /**
  * @fileOverview Postal codes checks.
- * @module postalCodes
+ * @module PostalCodes
  */
 
 const Interface = require('../interface');

diff --git a/src/asserts/types.js b/src/asserts/types.js
@@ -49,7 +49,7 @@ Types.boolean = (value) => {
 };
 
 /**
- * Check if is false boolean type
+ * Alias of `be.false`
  *
  * **Interfaces**: `all`, `any`, `not`
  *
@@ -84,12 +84,12 @@ Types.false = (value) => {
 };
 
 /**
- * Check if is true boolean type
+ * Alias of `be.true`
  *
  * **Interfaces**: `all`, `any`, `not`
  *
  * @function
- * @name booleanTrue
+ * @name booleanTru
  * @alias true
  * @param value {Mixed} value
  * @returns {boolean}

diff --git a/src/be.js b/src/be.js
@@ -1,6 +1,6 @@
 /**
  * @module be
- * @description
+ * @fileOverview
  * beJS has the following interfaces:
  *
  * - `all`, all checks must be satisfied
@@ -93,6 +93,8 @@ let Checks = {
 
 /**
  * Get version of framework
+ * @function
+ * @name getVersion
  * @memberOf be
  * @returns {string}
  */