Skip to content

Commit

Permalink
doc: update tools/doc/README.md
Browse files Browse the repository at this point in the history
PR-URL: #20047
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
  • Loading branch information
vsemozhetbyt authored and jasnell committed Apr 16, 2018
1 parent ae327d6 commit a93a0ec
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions tools/doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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.
Expand All @@ -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
<!-- YAML
added: v0.10.0
Expand All @@ -99,8 +102,8 @@ This event is emitted on instances of `SomeClass`, not on the module itself.


* Classes have (description, Properties, Methods, Events).
* Events have (list of arguments, description).
* Functions have (list of arguments, description).
* Methods have (list of arguments, description).
* Events have (list of listener arguments, description).
* Functions have (list of arguments, returned value if defined, description).
* Methods have (list of arguments, returned value if defined, description).
* Modules have (description, Properties, Functions, Classes, Examples).
* Properties have (type, description).

0 comments on commit a93a0ec

Please sign in to comment.