Merge branch 'develop' into v4

josdejong · josdejong · commit 7f6f997fa3a9 · 2018-02-25T14:00:41.000+01:00
diff --git a/docs/reference/functions/createUnit.md b/docs/reference/functions/createUnit.md
@@ -29,7 +29,7 @@ Parameter | Type | Description
 --------- | ---- | -----------
 `name` | string | The name of the new unit. Must be unique. Example: 'knot'
 `definition` | string, Unit | Definition of the unit in terms of existing units. For example, '0.514444444 m / s'.
-`options` | Object | (optional) An object containing any of the following properties:
+`options` | Object | (optional) An object containing any of the following properties:</br>- `prefixes {string}` "none", "short", "long", "binary_short", or "binary_long". The default is "none".</br>- `aliases {Array}` Array of strings. Example: ['knots', 'kt', 'kts']</br>- `offset {Numeric}` An offset to apply when converting from the unit. For example, the offset for celsius is 273.15. Default is 0.
 
 ### Returns
 
diff --git a/docs/reference/functions/parse.md b/docs/reference/functions/parse.md
@@ -23,7 +23,7 @@ math.parse([expr1, expr2, expr3, ...], options)
 Parameter | Type | Description
 --------- | ---- | -----------
 `expr` | string &#124; string[] &#124; Matrix | Expression to be parsed
-`options` | {nodes: Object&lt;string, Node&gt;} | Available options: - `nodes` a set of custom nodes
+`options` | {nodes: Object&lt;string, Node&gt;} | Available options:</br>- `nodes` a set of custom nodes
 
 ### Returns
 
diff --git a/docs/reference/functions/qr.md b/docs/reference/functions/qr.md
@@ -17,13 +17,13 @@ math.qr(A);
 
 Parameter | Type | Description
 --------- | ---- | -----------
-`A` | Matrix &#124; Array | A two dimensional matrix or array
+`A` | Matrix &#124; Array | A two dimensional matrix or array for which to get the QR decomposition.
 
 ### Returns
 
 Type | Description
 ---- | -----------
-{Q: Array &#124; Matrix, R: Array &#124; Matrix} | Q: the orthogonal
+{Q: Array &#124; Matrix, R: Array &#124; Matrix} | Q: the orthogonal matrix and R: the upper triangular matrix
 
 
 ## Examples
diff --git a/lib/type/unit/function/createUnit.js b/lib/type/unit/function/createUnit.js
@@ -34,9 +34,9 @@ function factory (type, config, load, typed) {
    * @param {string} name      The name of the new unit. Must be unique. Example: 'knot'
    * @param {string, Unit} definition      Definition of the unit in terms of existing units. For example, '0.514444444 m / s'.
    * @param {Object} options   (optional) An object containing any of the following properties:
-   *     prefixes {string} "none", "short", "long", "binary_short", or "binary_long". The default is "none".
-   *     aliases {Array} Array of strings. Example: ['knots', 'kt', 'kts']
-   *     offset {Numeric} An offset to apply when converting from the unit. For example, the offset for celsius is 273.15. Default is 0.
+   *     - `prefixes {string}` "none", "short", "long", "binary_short", or "binary_long". The default is "none".
+   *     - `aliases {Array}` Array of strings. Example: ['knots', 'kt', 'kts']
+   *     - `offset {Numeric}` An offset to apply when converting from the unit. For example, the offset for celsius is 273.15. Default is 0.
    *
    * See also:
    *
diff --git a/package.json b/package.json
@@ -139,7 +139,7 @@
     "mathjs": "./bin/cli.js"
   },
   "engines": {
-    "node": ">= 0.1"
+    "node": ">= 4"
   },
   "bugs": {
     "url": "https://github.com/josdejong/mathjs/issues"
diff --git a/tools/docgenerator.js b/tools/docgenerator.js
@@ -246,9 +246,11 @@ function generateDoc(name, code) {
           annotation.description = annotation.description.substring(index + 1).trim();
         }
 
-        // multi line description
-        while (exists() && !empty() && /^\s{6}/.test(line)) {
-          annotation.description += ' ' + line.trim();
+        // multi line description (must be non-empty and not start with @param or @return)
+        while (exists() && !empty() && !/^\s*@/.test(line)) {
+          var lineTrim = line.trim()
+          var separator = (lineTrim[0] === '-' ? '</br>' : ' ');
+          annotation.description += separator + lineTrim;
           next();
         }
 
@@ -272,7 +274,7 @@ function generateDoc(name, code) {
       };
 
       // multi line description
-      while (exists() && !empty() && /^\s{6}/.test(line)) {
+      while (exists() && !empty() && !/^\s*@/.test(line)) {
         doc.returns.description += ' ' + line.trim();
         next();
       }

Original file line number	Diff line number	Diff line change
`@@ -34,9 +34,9 @@ function factory (type, config, load, typed) {`
`34`	`34`	`* @param {string} name The name of the new unit. Must be unique. Example: 'knot'`
`35`	`35`	`* @param {string, Unit} definition Definition of the unit in terms of existing units. For example, '0.514444444 m / s'.`
`36`	`36`	`* @param {Object} options (optional) An object containing any of the following properties:`
`37`		`- * prefixes {string} "none", "short", "long", "binary_short", or "binary_long". The default is "none".`
`38`		`- * aliases {Array} Array of strings. Example: ['knots', 'kt', 'kts']`
`39`		`- * offset {Numeric} An offset to apply when converting from the unit. For example, the offset for celsius is 273.15. Default is 0.`
	`37`	+ * - `prefixes {string}` "none", "short", "long", "binary_short", or "binary_long". The default is "none".
	`38`	+ * - `aliases {Array}` Array of strings. Example: ['knots', 'kt', 'kts']
	`39`	+ * - `offset {Numeric}` An offset to apply when converting from the unit. For example, the offset for celsius is 273.15. Default is 0.
`40`	`40`	`*`
`41`	`41`	`* See also:`
`42`	`42`	`*`