jsdoc: clarify params

This commit is contained in:
Rico Sta. Cruz 2017-10-29 23:49:18 +08:00
parent 78701ecb78
commit eb736e9c1d
No known key found for this signature in database
GPG Key ID: CAAD38AE2962619A
1 changed files with 28 additions and 18 deletions

View File

@ -9,17 +9,15 @@ weight: -1
### Functions ### Functions
```js ```js
/* /**
* This is a function.
*
* @param {string} n - A string param * @param {string} n - A string param
* @return {string} A good string * @return {string} A good string
* *
* @throws {FooException} * @example
* @private
* @deprecated
* @see
* *
* @function * foo('hello')
* @class
*/ */
function foo(n) { return n } function foo(n) { return n }
@ -29,17 +27,15 @@ See: <http://usejsdoc.org/index.html>
### Types ### Types
``` | Type | Description |
/** | --- | --- |
* @param {string=} n - Optional param | `@param {string=} n` | Optional |
* @param {string} [n] - Optional param | `@param {string} [n]` | Optional |
* @param {(string|number)} n - Multiple types | `@param {(string|number)} n` | Multiple types |
* @param {*} n - Any type | `@param {*} n` | Any type |
* @param {...string} n - Repeatable arguments | `@param {...string} n` | Repeatable arguments |
* @param {string} [n="hi"] - Optional param with default | `@param {string} [n="hi"]` | Optional with default |
* @param {string[]} n - An array of strings | `@param {string[]} n` | Array of strings |
*/
```
See: <http://usejsdoc.org/tags-type.html> See: <http://usejsdoc.org/tags-type.html>
@ -83,6 +79,20 @@ function play (song) {
See: <http://usejsdoc.org/tags-typedef.html> See: <http://usejsdoc.org/tags-typedef.html>
### Other keywodrs
```js
/**
* @throws {FooException}
* @private
* @deprecated
* @see
*
* @function
* @class
*/
```
### Renaming ### Renaming
```js ```js