61 lines
1.1 KiB
Markdown
61 lines
1.1 KiB
Markdown
#### Support nestled JSDoc comments (#13445 by @thorn0)
|
|
|
|
This kind of comments is used to document overloaded functions (see https://github.com/jsdoc/jsdoc/issues/1017).
|
|
|
|
<!-- prettier-ignore -->
|
|
```jsx
|
|
// Input
|
|
/**
|
|
* @template T
|
|
* @param {Type} type
|
|
* @param {T} value
|
|
* @return {Value}
|
|
*//**
|
|
* @param {Type} type
|
|
* @return {Value}
|
|
*/
|
|
function value(type, value) {
|
|
if (arguments.length === 2) {
|
|
return new ConcreteValue(type, value);
|
|
} else {
|
|
return new Value(type);
|
|
}
|
|
}
|
|
|
|
// Prettier stable
|
|
/**
|
|
* @template T
|
|
* @param {Type} type
|
|
* @param {T} value
|
|
* @return {Value}
|
|
*/ /**
|
|
* @param {Type} type
|
|
* @return {Value}
|
|
*/
|
|
function value(type, value) {
|
|
if (arguments.length === 2) {
|
|
return new ConcreteValue(type, value);
|
|
} else {
|
|
return new Value(type);
|
|
}
|
|
}
|
|
|
|
// Prettier main
|
|
/**
|
|
* @template T
|
|
* @param {Type} type
|
|
* @param {T} value
|
|
* @return {Value}
|
|
*//**
|
|
* @param {Type} type
|
|
* @return {Value}
|
|
*/
|
|
function value(type, value) {
|
|
if (arguments.length === 2) {
|
|
return new ConcreteValue(type, value);
|
|
} else {
|
|
return new Value(type);
|
|
}
|
|
}
|
|
```
|