diff --git a/tools/doc/README.md b/tools/doc/README.md index 2d5317db9e6fd7..8c183b38989684 100644 --- a/tools/doc/README.md +++ b/tools/doc/README.md @@ -29,7 +29,7 @@ added: v0.10.0 * `x` {string} The description of the string. * `y` {boolean} Should I stay or should I go? -* `z` {number} How many zebras to bring. +* `z` {number} How many zebras to bring. **Default:** `100`. A description of the function. @@ -66,7 +66,7 @@ added: v0.10.0 * `anArg` {Object} Just an argument. * `field` {string} `anArg` can have this field. - * `field2` {boolean} Another field. Default: `false`. + * `field2` {boolean} Another field. **Default:** `false`. * Returns: {boolean} `true` if it worked. A description of the method for humans. @@ -78,6 +78,9 @@ added: v0.10.0 * Returns: {SomeClass | null} The next `SomeClass` in line. +`SomeClass` must be registered in `tools/doc/type-parser.js` +to be properly parsed in `{type}` fields. + ### SomeClass.someProperty