File tree 1 file changed +6
-4
lines changed
1 file changed +6
-4
lines changed Original file line number Diff line number Diff line change @@ -81,11 +81,11 @@ JSDoc will be read and automatically processed by `generate:api-docs` and theref
81
81
> We have a small set of JSDoc tags that all methods should have.
82
82
83
83
- Description
84
- - ` @see ` - If there are other important methods
85
84
- ` @param ` - If the method has parameters
85
+ - ` @see ` - If there are other important methods
86
86
- ` @example ` - Example calls without and with parameters, including a sample result each
87
- - ` @deprecated ` - If the method is deprecated, with additional information about replacements
88
87
- ` @since ` - The version this method was added (or is likely to be added)
88
+ - ` @deprecated ` - If the method is deprecated, with additional information about replacements
89
89
90
90
<table >
91
91
<tr >
@@ -99,15 +99,17 @@ JSDoc will be read and automatically processed by `generate:api-docs` and theref
99
99
/**
100
100
* This is a good JSDoc description for a method that generates foos.
101
101
*
102
- * @see faker.helper.fake
103
- *
104
102
* @param options The optional options to use.
105
103
* @param options.test The parameter to configure test. Defaults to `'bar'`.
106
104
*
105
+ * @see faker.helper.fake
106
+ *
107
107
* @example
108
108
* faker.bar.foo() // 'foo'
109
109
* faker.bar.foo({ test: 'oof' }) // 'of'
110
110
*
111
+ * @since 7.5.0
112
+ *
111
113
* @deprecated Use faker.cat.random() instead.
112
114
*/
113
115
function foo(options : { test: string } = {}): string {
You can’t perform that action at this time.
0 commit comments