Skip to content

Commit f391181

Browse files
vsemozhetbytMylesBorins
authored andcommitted
doc: update tools/doc/README.md
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>
1 parent 8a5c100 commit f391181

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

tools/doc/README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ added: v0.10.0
2929

3030
* `x` {string} The description of the string.
3131
* `y` {boolean} Should I stay or should I go?
32-
* `z` {number} How many zebras to bring.
32+
* `z` {number} How many zebras to bring. **Default:** `100`.
3333

3434
A description of the function.
3535

@@ -66,7 +66,7 @@ added: v0.10.0
6666

6767
* `anArg` {Object} Just an argument.
6868
* `field` {string} `anArg` can have this field.
69-
* `field2` {boolean} Another field. Default: `false`.
69+
* `field2` {boolean} Another field. **Default:** `false`.
7070
* Returns: {boolean} `true` if it worked.
7171

7272
A description of the method for humans.
@@ -78,6 +78,9 @@ added: v0.10.0
7878

7979
* Returns: {SomeClass | null} The next `SomeClass` in line.
8080

81+
`SomeClass` must be registered in `tools/doc/type-parser.js`
82+
to be properly parsed in `{type}` fields.
83+
8184
### SomeClass.someProperty
8285
<!-- YAML
8386
added: v0.10.0
@@ -99,8 +102,8 @@ This event is emitted on instances of `SomeClass`, not on the module itself.
99102

100103

101104
* Classes have (description, Properties, Methods, Events).
102-
* Events have (list of arguments, description).
103-
* Functions have (list of arguments, description).
104-
* Methods have (list of arguments, description).
105+
* Events have (list of listener arguments, description).
106+
* Functions have (list of arguments, returned value if defined, description).
107+
* Methods have (list of arguments, returned value if defined, description).
105108
* Modules have (description, Properties, Functions, Classes, Examples).
106109
* Properties have (type, description).

0 commit comments

Comments
 (0)