@@ -29,7 +29,7 @@ added: v0.10.0
29
29
30
30
* `x` {string} The description of the string.
31
31
* `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`.
33
33
34
34
A description of the function.
35
35
@@ -66,7 +66,7 @@ added: v0.10.0
66
66
67
67
* `anArg` {Object} Just an argument.
68
68
* `field` {string} `anArg` can have this field.
69
- * `field2` {boolean} Another field. Default: `false`.
69
+ * `field2` {boolean} Another field. ** Default:** `false`.
70
70
* Returns: {boolean} `true` if it worked.
71
71
72
72
A description of the method for humans.
@@ -78,6 +78,9 @@ added: v0.10.0
78
78
79
79
* Returns: {SomeClass | null} The next `SomeClass` in line.
80
80
81
+ `SomeClass` must be registered in `tools/doc/type-parser.js`
82
+ to be properly parsed in `{type}` fields.
83
+
81
84
### SomeClass.someProperty
82
85
<!-- YAML
83
86
added: v0.10.0
@@ -99,8 +102,8 @@ This event is emitted on instances of `SomeClass`, not on the module itself.
99
102
100
103
101
104
* 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).
105
108
* Modules have (description, Properties, Functions, Classes, Examples).
106
109
* Properties have (type, description).
0 commit comments