[fixed] jsdoc for optinal arguments contains the default value

thealjey · Sep 29, 2015 · 1ecb8ab · 1ecb8ab
1 parent 111d8a9
commit 1ecb8ab
Show file tree

Hide file tree

Showing 22 changed files with 171 additions and 58 deletions.
diff --git a/build/DevServer.js b/build/DevServer.js
@@ -41,11 +41,11 @@ var _path = require('path');
  * Please install and enable the LiveReload browser extension for the CSS reloading to work.
  *
  * @class
- * @param {string}  script  - a full system path to a JavaScript file
- * @param {string}  style   - a full system path to a SASS file
- * @param {string}  devDir  - a full system path to a directory in which to put any compiled development resources
- * @param {number}  [port]  - a port at which to start the dev server, defaults to 3000
- * @param {boolean} [react] - false to disable the react hot loader plugin, defaults to true
+ * @param {string}  script       - a full system path to a JavaScript file
+ * @param {string}  style        - a full system path to a SASS file
+ * @param {string}  devDir       - a full system path to a directory in which to put any compiled development resources
+ * @param {number}  [port=3000]  - a port at which to start the dev server
+ * @param {boolean} [react=true] - false to disable the react hot loader plugin
  * @example
  * import {DevServer} from 'webcompiler';
  * import {join} from 'path';

diff --git a/build/JS.js b/build/JS.js
@@ -50,7 +50,7 @@ var i = 0;
  * A JavaScript compiler
  *
  * @class
- * @param {Object} [rules] - an object that lets you override default linting rules
+ * @param {Object} [rules={}] - an object that lets you override default linting rules
  * @example
  * import {JS} from 'webcompiler';
  *

diff --git a/build/JSLint.js b/build/JSLint.js
@@ -16,7 +16,7 @@ var _path = require('path');
  * A JavaScript linter
  *
  * @class
- * @param {Object} [rules] - an object that lets you override default linting rules
+ * @param {Object} [rules={}] - an object that lets you override default linting rules
  * @example
  * import {JSLint} from 'webcompiler';
  * import {join} from 'path';

diff --git a/build/NativeProcess.js b/build/NativeProcess.js
@@ -42,10 +42,10 @@ var NativeProcess = (function () {
    * @memberof NativeProcess
    * @instance
    * @method run
-   * @param {Function}      callback - a callback function, accepts 2 arguments: an error string or null and the
-   *                                   response string
-   * @param {Array<string>} [args]   - an optional array of arguments to pass to the process
-   * @param {Object}        [opts]   - an optional object containing configuration options for the process
+   * @param {Function}      callback  - a callback function, accepts 2 arguments: an error string or null and the
+   *                                    response string
+   * @param {Array<string>} [args=[]] - an optional array of arguments to pass to the process
+   * @param {Object}        [opts={}] - an optional object containing configuration options for the process
    * @example
    * mkdir.run(function (e) {
    *   if (e) {

diff --git a/build/SASS.js b/build/SASS.js
@@ -45,10 +45,10 @@ var i = 0;
  * A SASS compiler
  *
  * @class
- * @param {Array<string>} [excludeLinter]     - names of linters to exclude
- * @param {Object}        [importOnceOptions] - an object that lets you override default importOnce resolver
- *                                              configuration
- * @param {Array<string>} [includePaths]      - an array of additional include paths
+ * @param {Array<string>} [excludeLinter=[]]     - names of linters to exclude
+ * @param {Object}        [importOnceOptions={}] - an object that lets you override default importOnce resolver
+ *                                                 configuration
+ * @param {Array<string>} [includePaths=[]]      - an array of additional include paths
  * @example
  * import {SASS} from 'webcompiler';
  *

diff --git a/build/SASSCompile.js b/build/SASSCompile.js
@@ -31,8 +31,9 @@ var options = {
  * SCSS file compiler
  *
  * @class
- * @param {Object}    [importOnceOptions] - an object that lets you override default importOnce resolver configuration
- * @param {...string} includePaths        - an array of additional include paths
+ * @param {Object}        [importOnceOptions={}] - an object that lets you override default importOnce resolver
+ *                                                 configuration
+ * @param {Array<string>} [includePaths=[]]      - an array of additional include paths
  * @example
  * import {SASSCompile} from 'webcompiler';
  *

diff --git a/build/jsWebCompile.js b/build/jsWebCompile.js
@@ -32,10 +32,10 @@ var config = {
 /**
  * Compiles JavaScript for the browser
  *
- * @param {string}   inPath    - a full system path to the input file
- * @param {string}   outPath   - a full system path to the output file
- * @param {Function} callback  - a callback function which accepts 1 argument: an array of error strings or null
- * @param {boolean}  [devMode] - if true provides faster source map rebuilds, good for rapid development
+ * @param {string}   inPath          - a full system path to the input file
+ * @param {string}   outPath         - a full system path to the output file
+ * @param {Function} callback        - a callback function which accepts 1 argument: an array of error strings or null
+ * @param {boolean}  [devMode=false] - if true provides faster source map rebuilds, good for rapid development
  * @example
  * import {jsWebCompile} from 'webcompiler';
  *

diff --git a/docs/DevServer.html b/docs/DevServer.html
@@ -81,6 +81,8 @@ <h5>Parameters:</h5>
 
 
 
+        <th>Default</th>
+
 
         <th class="last">Description</th>
     </tr>
@@ -114,6 +116,10 @@ <h5>Parameters:</h5>
 
 
 
+                <td class="default">
+
+                </td>
+
 
             <td class="description last">a full system path to a JavaScript file</td>
         </tr>
@@ -145,6 +151,10 @@ <h5>Parameters:</h5>
 
 
 
+                <td class="default">
+
+                </td>
+
 
             <td class="description last">a full system path to a SASS file</td>
         </tr>
@@ -176,6 +186,10 @@ <h5>Parameters:</h5>
 
 
 
+                <td class="default">
+
+                </td>
+
 
             <td class="description last">a full system path to a directory in which to put any compiled development resources</td>
         </tr>
@@ -209,8 +223,14 @@ <h5>Parameters:</h5>
 
 
 
+                <td class="default">
+
+                    3000
+
+                </td>
+
 
-            <td class="description last">a port at which to start the dev server, defaults to 3000</td>
+            <td class="description last">a port at which to start the dev server</td>
         </tr>
 
 
@@ -242,8 +262,14 @@ <h5>Parameters:</h5>
 
 
 
+                <td class="default">
+
+                    true
+
+                </td>
+
 
-            <td class="description last">false to disable the react hot loader plugin, defaults to true</td>
+            <td class="description last">false to disable the react hot loader plugin</td>
         </tr>
 
 

diff --git a/docs/JS.html b/docs/JS.html
@@ -77,6 +77,8 @@ <h5>Parameters:</h5>
 
 
 
+        <th>Default</th>
+
 
         <th class="last">Description</th>
     </tr>
@@ -112,6 +114,12 @@ <h5>Parameters:</h5>
 
 
 
+                <td class="default">
+
+                    {}
+
+                </td>
+
 
             <td class="description last">an object that lets you override default linting rules</td>
         </tr>

diff --git a/docs/JSLint.html b/docs/JSLint.html
@@ -77,6 +77,8 @@ <h5>Parameters:</h5>
 
 
 
+        <th>Default</th>
+
 
         <th class="last">Description</th>
     </tr>
@@ -112,6 +114,12 @@ <h5>Parameters:</h5>
 
 
 
+                <td class="default">
+
+                    {}
+
+                </td>
+
 
             <td class="description last">an object that lets you override default linting rules</td>
         </tr>

diff --git a/docs/NativeProcess.html b/docs/NativeProcess.html
@@ -228,6 +228,8 @@ <h5>Parameters:</h5>
 
 
 
+        <th>Default</th>
+
 
         <th class="last">Description</th>
     </tr>
@@ -261,9 +263,13 @@ <h5>Parameters:</h5>
 
 
 
+                <td class="default">
+
+                </td>
+
 
             <td class="description last">a callback function, accepts 2 arguments: an error string or null and the
-                                  response string</td>
+                                   response string</td>
         </tr>
 
 
@@ -295,6 +301,12 @@ <h5>Parameters:</h5>
 
 
 
+                <td class="default">
+
+                    []
+
+                </td>
+
 
             <td class="description last">an optional array of arguments to pass to the process</td>
         </tr>
@@ -328,6 +340,12 @@ <h5>Parameters:</h5>
 
 
 
+                <td class="default">
+
+                    {}
+
+                </td>
+
 
             <td class="description last">an optional object containing configuration options for the process</td>
         </tr>

diff --git a/docs/SASS.html b/docs/SASS.html
@@ -77,6 +77,8 @@ <h5>Parameters:</h5>
 
 
 
+        <th>Default</th>
+
 
         <th class="last">Description</th>
     </tr>
@@ -112,6 +114,12 @@ <h5>Parameters:</h5>
 
 
 
+                <td class="default">
+
+                    []
+
+                </td>
+
 
             <td class="description last">names of linters to exclude</td>
         </tr>
@@ -145,9 +153,15 @@ <h5>Parameters:</h5>
 
 
 
+                <td class="default">
+
+                    {}
+
+                </td>
+
 
             <td class="description last">an object that lets you override default importOnce resolver
-                                             configuration</td>
+                                                configuration</td>
         </tr>
 
 
@@ -179,6 +193,12 @@ <h5>Parameters:</h5>
 
 
 
+                <td class="default">
+
+                    []
+
+                </td>
+
 
             <td class="description last">an array of additional include paths</td>
         </tr>

diff --git a/docs/SASSCompile.html b/docs/SASSCompile.html
@@ -42,7 +42,7 @@ <h2>
 
 
 
-    <h4 class="name" id="SASSCompile"><span class="type-signature"></span>new SASSCompile<span class="signature">(importOnceOptions<span class="signature-attributes">opt</span>, &hellip;includePaths)</span><span class="type-signature"></span></h4>
+    <h4 class="name" id="SASSCompile"><span class="type-signature"></span>new SASSCompile<span class="signature">(importOnceOptions<span class="signature-attributes">opt</span>, includePaths<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
 
 
 
@@ -77,6 +77,8 @@ <h5>Parameters:</h5>
 
 
 
+        <th>Default</th>
+
 
         <th class="last">Description</th>
     </tr>
@@ -112,8 +114,15 @@ <h5>Parameters:</h5>
 
 
 
+                <td class="default">
+
+                    {}
+
+                </td>
+
 
-            <td class="description last">an object that lets you override default importOnce resolver configuration</td>
+            <td class="description last">an object that lets you override default importOnce resolver
+                                                configuration</td>
         </tr>
 
 
@@ -126,7 +135,7 @@ <h5>Parameters:</h5>
             <td class="type">
 
 
-<span class="param-type">string</span>
+<span class="param-type">Array.&lt;string></span>
 
 
 
@@ -135,16 +144,22 @@ <h5>Parameters:</h5>
 
                 <td class="attributes">
 
-
+                    &lt;optional><br>
 
 
 
-                    &lt;repeatable><br>
+
 
                 </td>
 
 
 
+                <td class="default">
+
+                    []
+
+                </td>
+
 
             <td class="description last">an array of additional include paths</td>
         </tr>
-Original file line number
+Diff line change
@@ Expand Up / @@ -77,6 +77,8 @@ <h5>Parameters:</h5> @@
+            <th>Default</th>
             <th class="last">Description</th>
         </tr>
@@ Expand Down Expand Up / @@ -112,6 +114,12 @@ <h5>Parameters:</h5> @@
+                    <td class="default">
+                        {}
+                    </td>
                 <td class="description last">an object that lets you override default linting rules</td>
             </tr>
@@ Expand Down @@