Skip to content

Commit 83ff68f

Browse files
committed
docs: generate docs (fixes #74)
1 parent 6413e7d commit 83ff68f

File tree

2 files changed

+322
-16
lines changed

2 files changed

+322
-16
lines changed

.README/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,21 @@ Use `settings.jsdoc.additionalTagNames` to configure additional, allowed JSDoc t
124124
}
125125
```
126126

127+
### Allow `@override` Without Accompanying `@param` Tags
128+
129+
Use `settings.jsdoc.allowOverrideWithoutParam` to indicate whether the `@override` tag can be used without accompanying `@param` tag(s). The default value is `false`. The format of the configuration is as follows:
130+
131+
```json
132+
{
133+
"rules": {},
134+
"settings": {
135+
"jsdoc": {
136+
"allowOverrideWithoutParam": true
137+
}
138+
}
139+
}
140+
```
141+
127142
## Rules
128143

129144
{"gitdown": "include", "file": "./rules/check-param-names.md"}

0 commit comments

Comments
 (0)