Fix documentation warnings

BoolJS · Sep 22, 2015 · 327724c · 327724c
1 parent cbc5508
commit 327724c
Show file tree

Hide file tree

Showing 12 changed files with 16 additions and 14 deletions.
diff --git a/doc/api_configurations_index.js.html b/doc/api_configurations_index.js.html
@@ -31,7 +31,7 @@ <h1 class="page-title">Source: api/configurations/index.js</h1>
 /**
  * Read configuration files
  * @param {Object} instance - Application's instance
- * @param {[type]} route - Configuration's directory
+ * @param {String} route - Configuration's directory
  * @param {module:booljs~doneCallback} done - Executed once reading process is
  * completed
  * @param {module:booljs~progressCallback} progress - Executed after each file
@@ -117,7 +117,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-bo
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Tue Sep 22 2015 02:34:29 GMT-0500 (COT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Tue Sep 22 2015 03:54:07 GMT-0500 (COT)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/doc/api_folder_read.js.html b/doc/api_folder_read.js.html
@@ -31,7 +31,8 @@ <h1 class="page-title">Source: api/folder/read.js</h1>
 /**
  * Read generic folders, setting names to namespaces order
  * @param {Object} instance - Application's instance
- * @param {[type]} route - Configuration's directory
+ * @param {Object} component - The component type to be inserted into
+ * @param {String} route - Components's directory
  * @param {module:booljs~doneCallback} done - Executed once reading process is
  * completed
  * @param {module:booljs~progressCallback} progress - Executed after each file
@@ -112,7 +113,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-bo
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Tue Sep 22 2015 02:34:29 GMT-0500 (COT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Tue Sep 22 2015 03:54:07 GMT-0500 (COT)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/doc/api_index.js.html b/doc/api_index.js.html
@@ -265,7 +265,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-bo
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Tue Sep 22 2015 02:34:29 GMT-0500 (COT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Tue Sep 22 2015 03:54:07 GMT-0500 (COT)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/doc/api_log_index.js.html b/doc/api_log_index.js.html
@@ -81,7 +81,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-bo
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Tue Sep 22 2015 02:34:29 GMT-0500 (COT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Tue Sep 22 2015 03:54:07 GMT-0500 (COT)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/doc/index.html b/doc/index.html
@@ -65,7 +65,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-bo
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Tue Sep 22 2015 02:34:29 GMT-0500 (COT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Tue Sep 22 2015 03:54:07 GMT-0500 (COT)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/doc/index.js.html b/doc/index.js.html
@@ -81,7 +81,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-bo
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Tue Sep 22 2015 02:34:29 GMT-0500 (COT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Tue Sep 22 2015 03:54:07 GMT-0500 (COT)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/doc/module-booljs.html b/doc/module-booljs.html
@@ -2026,7 +2026,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-bo
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Tue Sep 22 2015 02:34:29 GMT-0500 (COT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Tue Sep 22 2015 03:54:08 GMT-0500 (COT)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/doc/readers_index.js.html b/doc/readers_index.js.html
@@ -100,7 +100,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-bo
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Tue Sep 22 2015 02:34:29 GMT-0500 (COT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Tue Sep 22 2015 03:54:07 GMT-0500 (COT)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/lib/api/folder/list.js b/lib/api/folder/list.js
@@ -2,7 +2,7 @@
 
 /**
  * @private
- * Folder's list by instance
+ * @description Folder's list by instance
  * @return {Object} A folders' list manager
  */
 module.exports = function(){

diff --git a/lib/api/loaders/components.js b/lib/api/loaders/components.js
@@ -2,7 +2,8 @@
 
 /**
  * @private
- * Loads components from folder list and insert them into application's instance
+ * @description Loads components from folder list and insert them into
+ * application's instance
  * @param  {Object} _folders - Object managing folders
  * @param  {Object} _instance - Application instance
  * @return {Promise}

diff --git a/lib/api/loaders/database.js b/lib/api/loaders/database.js
@@ -2,7 +2,7 @@
 
 /**
  * @private
- * Loads database from a DatabaseLoader plugin
+ * @description Loads database from a DatabaseLoader plugin
  * @param {Object} _instance - The application instance
  * @param {Object} _loader - An existing database loader
  * @return {Promise}

diff --git a/lib/api/loaders/server.js b/lib/api/loaders/server.js
@@ -2,7 +2,7 @@
 
 /**
  * @private
- * Boots server using instance data and a server plug-in
+ * @description Boots server using instance data and a server plug-in
  * @param  {Object} _instance - Application's instance
  * @param  {Object} _loader - Server loader plugin
  * @return {Promise}