diff --git a/default_theme/section._ b/default_theme/section._ index d8d6c68e7..06f7bd2f4 100644 --- a/default_theme/section._ +++ b/default_theme/section._ @@ -43,8 +43,8 @@
<%- param.name%> (<%= formatType(param.type) %><% if (param.default) { %> - (default <%- param.default %>) - <% } %>) <%= md(param.description, true) %> + = <%- param.default %><% } %>) + <%= md(param.description, true) %>
<% if (param.properties) { %> diff --git a/lib/output/util/format_type.js b/lib/output/util/format_type.js index 221dcfd0e..ff7b47302 100644 --- a/lib/output/util/format_type.js +++ b/lib/output/util/format_type.js @@ -73,7 +73,7 @@ function commaList(getHref, items, start, end, sep) { * * @param {Array} formatted remark AST of a type definition * @param {string} str postfix - * @param {string} prefix string to put after the type comment + * @param {boolean} prefix string to put after the type comment * @returns {Array} suffixed and potentially prefixed type */ function decorate(formatted, str, prefix) { @@ -163,12 +163,15 @@ function formatType(getHref, node) { // lets the expression be omitted. return decorate(formatType(getHref, node.expression), '...', true); case Syntax.OptionalType: - return decorate(decorate(formatType(getHref, node.expression), '[', true), ']').concat( - node.default ? t('(default ' + node.default + ')') : []); + if (node.default) { + return decorate(formatType(getHref, node.expression), '?') + .concat(t('= ' + node.default)); + } + return decorate(formatType(getHref, node.expression), '?'); case Syntax.NonNullableType: return decorate(formatType(getHref, node.expression), '!', node.prefix); case Syntax.NullableType: - return decorate(formatType(getHref, node.expression), '?', node.prefix); + return decorate(formatType(getHref, node.expression), '?'); case Syntax.StringLiteralType: return [u('inlineCode', JSON.stringify(node.value))]; case Syntax.NumericLiteralType: diff --git a/lib/output/util/formatters.js b/lib/output/util/formatters.js index 7ecf6e154..efec537fe 100644 --- a/lib/output/util/formatters.js +++ b/lib/output/util/formatters.js @@ -28,8 +28,13 @@ module.exports = function (getHref) { */ formatters.parameter = function (param, short) { if (short) { - return (param.type && param.type.type == Syntax.OptionalType) ? - '[' + param.name + ']' : param.name; + if (param.type && param.type.type == Syntax.OptionalType) { + if (param.default) { + return param.name + ' = ' + param.default; + } + return param.name + '?'; + } + return param.name; } return param.name + ': ' + formatters.type(param.type).replace(/\n/g, ''); }; diff --git a/test/fixture/html/nested.output.files b/test/fixture/html/nested.output.files index 2add6ae99..9f741d9cf 100644 --- a/test/fixture/html/nested.output.files +++ b/test/fixture/html/nested.output.files @@ -240,7 +240,8 @@
- foo (any) + foo (any) +
@@ -293,14 +294,16 @@ This is a [link to something that does not exist]DoesNot
- other (Object) + other (Object) +
- also (any) + also (any) +
@@ -366,7 +369,8 @@ the referenced class type

- other (Weird) + other (Weird) +
@@ -404,7 +408,7 @@ the referenced class type

▸ - isBuffer(buf, [size]) + isBuffer(buf, size = 0)
@@ -772,7 +779,8 @@ k.isArrayOfBuffers();
- otherOptions (?number) + otherOptions (number?) +
@@ -968,7 +976,8 @@ like a klass

- toys (...Number) + toys (...Number) +
diff --git a/test/fixture/nearby_params.output.md b/test/fixture/nearby_params.output.md index 025dba5b6..46a8965a8 100644 --- a/test/fixture/nearby_params.output.md +++ b/test/fixture/nearby_params.output.md @@ -9,6 +9,6 @@ Attempt to establish a cookie-based session in exchange for credentials. - `credentials` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** - `credentials.name` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Login username. Also accepted as `username` or `email`. - `credentials.password` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Login password -- `callback` **\[[function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)]** Gets passed `(err, { success:Boolean })`. +- `callback` **[function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)?** Gets passed `(err, { success:Boolean })`. Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** promise, to be resolved on success or rejected on failure diff --git a/test/fixture/nearby_params.output.md.json b/test/fixture/nearby_params.output.md.json index 7f95aa0ff..42df8b139 100644 --- a/test/fixture/nearby_params.output.md.json +++ b/test/fixture/nearby_params.output.md.json @@ -338,10 +338,6 @@ { "type": "strong", "children": [ - { - "type": "text", - "value": "[" - }, { "href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function", "url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function", @@ -355,7 +351,7 @@ }, { "type": "text", - "value": "]" + "value": "?" } ] }, diff --git a/test/fixture/nest_params.output.md b/test/fixture/nest_params.output.md index 5d07af208..e0e27edc6 100644 --- a/test/fixture/nest_params.output.md +++ b/test/fixture/nest_params.output.md @@ -7,7 +7,7 @@ - `employees` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)>** The employees who are responsible for the project. - `employees[].name` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The name of an employee. - `employees[].department` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The employee's department. -- `type` **\[[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)]** The employee's type. (optional, default `minion`) +- `type` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** The employee's type. (optional, default `minion`) # foo diff --git a/test/fixture/nest_params.output.md.json b/test/fixture/nest_params.output.md.json index e470877e1..43901c6ce 100644 --- a/test/fixture/nest_params.output.md.json +++ b/test/fixture/nest_params.output.md.json @@ -289,10 +289,6 @@ { "type": "strong", "children": [ - { - "type": "text", - "value": "[" - }, { "href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String", "url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String", @@ -306,7 +302,7 @@ }, { "type": "text", - "value": "]" + "value": "?" } ] }, diff --git a/test/fixture/optional-record-field-type.output.md b/test/fixture/optional-record-field-type.output.md index da72f3c22..8cfccccb5 100644 --- a/test/fixture/optional-record-field-type.output.md +++ b/test/fixture/optional-record-field-type.output.md @@ -4,5 +4,5 @@ **Properties** -- `opt` **\[[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)]** +- `opt` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** - `req` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** diff --git a/test/fixture/optional-record-field-type.output.md.json b/test/fixture/optional-record-field-type.output.md.json index 167b8a1f4..20a89a866 100644 --- a/test/fixture/optional-record-field-type.output.md.json +++ b/test/fixture/optional-record-field-type.output.md.json @@ -45,10 +45,6 @@ { "type": "strong", "children": [ - { - "type": "text", - "value": "[" - }, { "href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number", "url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number", @@ -62,7 +58,7 @@ }, { "type": "text", - "value": "]" + "value": "?" } ] }, diff --git a/test/fixture/params.output.md b/test/fixture/params.output.md index af0cddd87..384ca453c 100644 --- a/test/fixture/params.output.md +++ b/test/fixture/params.output.md @@ -30,7 +30,7 @@ This method has a type in the description and a default in the code **Parameters** -- `x` **\[[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)](default 2)** +- `x` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?= 2** # Foo @@ -53,9 +53,9 @@ This tests our support of optional parameters **Parameters** - `address` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** An IPv6 address string -- `groups` **\[[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)]** How many octets to parse (optional, default `8`) -- `third` **?[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** A third argument -- `foo` **\[[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)]** to properly be parsed (optional, default `[1]`) +- `groups` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** How many octets to parse (optional, default `8`) +- `third` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** A third argument +- `foo` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)?** to properly be parsed (optional, default `[1]`) **Examples** @@ -71,12 +71,12 @@ This tests our support of nested parameters **Parameters** -- `options` **\[[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)]** optional options +- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** optional options - `options.data` **([Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) \| [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String))** A GeoJSON data object or URL to it. The latter is preferable in case of large GeoJSON files. - - `options.maxzoom` **\[[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)]** Maximum zoom to preserve detail at. (optional, default `14`) - - `options.buffer` **\[[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)]** Tile buffer on each side. - - `options.tolerance` **\[[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)]** Simplification tolerance (higher means simpler). + - `options.maxzoom` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Maximum zoom to preserve detail at. (optional, default `14`) + - `options.buffer` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Tile buffer on each side. + - `options.tolerance` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Simplification tolerance (higher means simpler). # myfunc @@ -85,7 +85,7 @@ values specified in code. **Parameters** -- `x` **\[[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)](default 123)** an argument +- `x` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?= 123** an argument Returns **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** some diff --git a/test/fixture/params.output.md.json b/test/fixture/params.output.md.json index 459100322..be4bc42a4 100644 --- a/test/fixture/params.output.md.json +++ b/test/fixture/params.output.md.json @@ -566,10 +566,6 @@ { "type": "strong", "children": [ - { - "type": "text", - "value": "[" - }, { "href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number", "url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number", @@ -583,11 +579,11 @@ }, { "type": "text", - "value": "]" + "value": "?" }, { "type": "text", - "value": "(default 2)" + "value": "= 2" } ] }, @@ -962,10 +958,6 @@ { "type": "strong", "children": [ - { - "type": "text", - "value": "[" - }, { "href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number", "url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number", @@ -979,7 +971,7 @@ }, { "type": "text", - "value": "]" + "value": "?" } ] }, @@ -1060,10 +1052,6 @@ { "type": "strong", "children": [ - { - "type": "text", - "value": "?" - }, { "href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number", "url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number", @@ -1074,6 +1062,10 @@ "value": "number" } ] + }, + { + "type": "text", + "value": "?" } ] }, @@ -1137,10 +1129,6 @@ { "type": "strong", "children": [ - { - "type": "text", - "value": "[" - }, { "href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array", "url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array", @@ -1154,7 +1142,7 @@ }, { "type": "text", - "value": "]" + "value": "?" } ] }, @@ -1344,10 +1332,6 @@ { "type": "strong", "children": [ - { - "type": "text", - "value": "[" - }, { "href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object", "url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object", @@ -1361,7 +1345,7 @@ }, { "type": "text", - "value": "]" + "value": "?" } ] }, @@ -1527,10 +1511,6 @@ { "type": "strong", "children": [ - { - "type": "text", - "value": "[" - }, { "href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number", "url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number", @@ -1544,7 +1524,7 @@ }, { "type": "text", - "value": "]" + "value": "?" } ] }, @@ -1625,10 +1605,6 @@ { "type": "strong", "children": [ - { - "type": "text", - "value": "[" - }, { "href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number", "url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number", @@ -1642,7 +1618,7 @@ }, { "type": "text", - "value": "]" + "value": "?" } ] }, @@ -1706,10 +1682,6 @@ { "type": "strong", "children": [ - { - "type": "text", - "value": "[" - }, { "href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number", "url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number", @@ -1723,7 +1695,7 @@ }, { "type": "text", - "value": "]" + "value": "?" } ] }, @@ -1855,10 +1827,6 @@ { "type": "strong", "children": [ - { - "type": "text", - "value": "[" - }, { "href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number", "url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number", @@ -1872,11 +1840,11 @@ }, { "type": "text", - "value": "]" + "value": "?" }, { "type": "text", - "value": "(default 123)" + "value": "= 123" } ] }, diff --git a/test/fixture/sync/flow-types.output.md b/test/fixture/sync/flow-types.output.md index 49e6256d7..ae907df12 100644 --- a/test/fixture/sync/flow-types.output.md +++ b/test/fixture/sync/flow-types.output.md @@ -50,7 +50,7 @@ Very Important Transform **Parameters** - `input` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)>** -- `options` **\[[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)]** (optional, default `{}`) +- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** (optional, default `{}`) Returns **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** @@ -60,7 +60,7 @@ Function with optional parameter. **Parameters** -- `x` **\[[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)]** (optional, default `42`) +- `x` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** (optional, default `42`) # objectParamFn diff --git a/test/fixture/sync/flow-types.output.md.json b/test/fixture/sync/flow-types.output.md.json index c1a045090..0a303ae91 100644 --- a/test/fixture/sync/flow-types.output.md.json +++ b/test/fixture/sync/flow-types.output.md.json @@ -1120,10 +1120,6 @@ { "type": "strong", "children": [ - { - "type": "text", - "value": "[" - }, { "href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object", "url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object", @@ -1137,7 +1133,7 @@ }, { "type": "text", - "value": "]" + "value": "?" } ] }, @@ -1272,10 +1268,6 @@ { "type": "strong", "children": [ - { - "type": "text", - "value": "[" - }, { "href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number", "url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number", @@ -1289,7 +1281,7 @@ }, { "type": "text", - "value": "]" + "value": "?" } ] }, diff --git a/test/fixture/sync/lots-of-options.output.md b/test/fixture/sync/lots-of-options.output.md index 83f9061b6..55321bdcb 100644 --- a/test/fixture/sync/lots-of-options.output.md +++ b/test/fixture/sync/lots-of-options.output.md @@ -8,18 +8,18 @@ Global spectra deconvolution - `x` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)>** Independent variable - `yIn` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)>** Dependent variable -- `options` **\[[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)]** Options object - - `options.sgOptions` **\[[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)]** Options object for Savitzky-Golay filter. See - - `options.minMaxRatio` **\[[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)]** Threshold to determine if a given peak should be considered as a noise (optional, default `0.00025`) - - `options.broadRatio` **\[[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)]** If `broadRatio` is higher than 0, then all the peaks which second derivative +- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Options object + - `options.sgOptions` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Options object for Savitzky-Golay filter. See + - `options.minMaxRatio` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Threshold to determine if a given peak should be considered as a noise (optional, default `0.00025`) + - `options.broadRatio` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** If `broadRatio` is higher than 0, then all the peaks which second derivative smaller than `broadRatio * maxAbsSecondDerivative` will be marked with the soft mask equal to true. (optional, default `0.00`) - - `options.noiseLevel` **\[[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)]** Noise threshold in spectrum units (optional, default `3`) - - `options.maxCriteria` **\[[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)]** Peaks are local maximum(true) or minimum(false) (optional, default `true`) - - `options.smoothY` **\[[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)]** Select the peak intensities from a smoothed version of the independent variables (optional, default `true`) - - `options.realTopDetection` **\[[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)]** Use a quadratic optimizations with the peak and its 3 closest neighbors + - `options.noiseLevel` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Noise threshold in spectrum units (optional, default `3`) + - `options.maxCriteria` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** Peaks are local maximum(true) or minimum(false) (optional, default `true`) + - `options.smoothY` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** Select the peak intensities from a smoothed version of the independent variables (optional, default `true`) + - `options.realTopDetection` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** Use a quadratic optimizations with the peak and its 3 closest neighbors to determine the true x,y values of the peak? (optional, default `false`) - - `options.heightFactor` **\[[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)]** Factor to multiply the calculated height (usually 2) (optional, default `0`) - - `options.boundaries` **\[[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)]** Return also the inflection points of the peaks (optional, default `false`) - - `options.derivativeThreshold` **\[[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)]** Filters based on the amplitude of the first derivative (optional, default `0`) + - `options.heightFactor` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Factor to multiply the calculated height (usually 2) (optional, default `0`) + - `options.boundaries` **[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** Return also the inflection points of the peaks (optional, default `false`) + - `options.derivativeThreshold` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Filters based on the amplitude of the first derivative (optional, default `0`) Returns **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)>** diff --git a/test/fixture/sync/lots-of-options.output.md.json b/test/fixture/sync/lots-of-options.output.md.json index 55189b7eb..0be407f12 100644 --- a/test/fixture/sync/lots-of-options.output.md.json +++ b/test/fixture/sync/lots-of-options.output.md.json @@ -264,10 +264,6 @@ { "type": "strong", "children": [ - { - "type": "text", - "value": "[" - }, { "href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object", "url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object", @@ -281,7 +277,7 @@ }, { "type": "text", - "value": "]" + "value": "?" } ] }, @@ -347,10 +343,6 @@ { "type": "strong", "children": [ - { - "type": "text", - "value": "[" - }, { "href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object", "url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object", @@ -364,7 +356,7 @@ }, { "type": "text", - "value": "]" + "value": "?" } ] }, @@ -465,10 +457,6 @@ { "type": "strong", "children": [ - { - "type": "text", - "value": "[" - }, { "href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number", "url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number", @@ -482,7 +470,7 @@ }, { "type": "text", - "value": "]" + "value": "?" } ] }, @@ -563,10 +551,6 @@ { "type": "strong", "children": [ - { - "type": "text", - "value": "[" - }, { "href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number", "url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number", @@ -580,7 +564,7 @@ }, { "type": "text", - "value": "]" + "value": "?" } ] }, @@ -733,10 +717,6 @@ { "type": "strong", "children": [ - { - "type": "text", - "value": "[" - }, { "href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number", "url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number", @@ -750,7 +730,7 @@ }, { "type": "text", - "value": "]" + "value": "?" } ] }, @@ -831,10 +811,6 @@ { "type": "strong", "children": [ - { - "type": "text", - "value": "[" - }, { "href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean", "url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean", @@ -848,7 +824,7 @@ }, { "type": "text", - "value": "]" + "value": "?" } ] }, @@ -929,10 +905,6 @@ { "type": "strong", "children": [ - { - "type": "text", - "value": "[" - }, { "href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean", "url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean", @@ -946,7 +918,7 @@ }, { "type": "text", - "value": "]" + "value": "?" } ] }, @@ -1027,10 +999,6 @@ { "type": "strong", "children": [ - { - "type": "text", - "value": "[" - }, { "href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean", "url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean", @@ -1044,7 +1012,7 @@ }, { "type": "text", - "value": "]" + "value": "?" } ] }, @@ -1129,10 +1097,6 @@ { "type": "strong", "children": [ - { - "type": "text", - "value": "[" - }, { "href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number", "url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number", @@ -1146,7 +1110,7 @@ }, { "type": "text", - "value": "]" + "value": "?" } ] }, @@ -1227,10 +1191,6 @@ { "type": "strong", "children": [ - { - "type": "text", - "value": "[" - }, { "href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean", "url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean", @@ -1244,7 +1204,7 @@ }, { "type": "text", - "value": "]" + "value": "?" } ] }, @@ -1325,10 +1285,6 @@ { "type": "strong", "children": [ - { - "type": "text", - "value": "[" - }, { "href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number", "url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number", @@ -1342,7 +1298,7 @@ }, { "type": "text", - "value": "]" + "value": "?" } ] }, diff --git a/test/format_type.js b/test/format_type.js index 8b872c137..570a627d5 100644 --- a/test/format_type.js +++ b/test/format_type.js @@ -33,12 +33,12 @@ test('formatType', function (t) { ['{myNum: number, myObject}', '{myNum: [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number), myObject}'], ['[string,]', '\\[[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)]'], ['number?', '[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?'], - ['?number', '?[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)'], + ['number', '[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)'], ['?', '?'], ['void', 'void'], ['function(a:b)', 'function (a: b)'], ['function(a):void', 'function (a): void'], - ['number=', '\\[[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)]'], + ['number=', '[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?'], ['...number', '...[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)'], ['undefined', '[undefined](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined)'] ].forEach(function (example) { @@ -49,7 +49,7 @@ test('formatType', function (t) { t.deepEqual(stringify(formatType( parse('@param {number} [a=1]', { sloppy: true }).tags[0].type) - ), '\\[[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)]', 'default'); + ), '[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)?', 'default'); t.deepEqual(stringify(_formatType(function (str) { return str.toUpperCase(); diff --git a/test/lib/output/util/formatters.js b/test/lib/output/util/formatters.js index 59495c17c..4a95b72a1 100644 --- a/test/lib/output/util/formatters.js +++ b/test/lib/output/util/formatters.js @@ -5,7 +5,7 @@ test('formatters.parameters -- long form', function (t) { t.deepEqual(formatters.parameters({}), '()'); t.deepEqual(formatters.parameters({ params: [] }), '()'); t.deepEqual(formatters.parameters({ params: [{ name: 'foo' }] }), '(foo: any)'); - t.deepEqual(formatters.parameters({ params: [{ name: 'foo', type: { type: 'OptionalType' } }] }), '(foo: [any])'); + t.deepEqual(formatters.parameters({ params: [{ name: 'foo', type: { type: 'OptionalType' } }] }), '(foo: any?)'); t.done(); }); @@ -15,7 +15,21 @@ test('formatters.parameters -- short form', function (t) { t.deepEqual(formatters.parameters({ params: [{ name: 'foo' }] }, true), '(foo)'); t.deepEqual(formatters.parameters({ params: [{ name: 'foo', type: { type: 'OptionalType' } }] - }, true), '([foo])'); + }, true), '(foo?)'); + t.deepEqual(formatters.parameters({ + params: [{ + title: 'param', + description: 'param', + type: { + type: 'OptionalType', + expression: { + type: 'NameExpression', + name: 'number' + }}, + name: 'bar', + default: '1' + }] + }, true), '(bar = 1)'); t.done(); });