Skip to content

Commit 4bf60e9

Browse files
committed
docs(allowEmptyNamepaths) Add all relevant tags in description and indicate why allowed
1 parent 068eef9 commit 4bf60e9

File tree

2 files changed

+12
-4
lines changed

2 files changed

+12
-4
lines changed

.README/README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -246,9 +246,13 @@ map will be assumed to be defined.
246246
### Settings to Configure `valid-types`
247247

248248
* `settings.jsdoc.allowEmptyNamepaths` - Set to `false` to disallow
249-
empty name paths with `@callback`, `@event`, `@listens`, `@fires`,
249+
empty name paths with `@callback`, `@event`, `@class`, `@constructor`,
250+
`@constant`, `@const`, `@function`, `@func`, `@method`, `@interface`,
251+
`@member`, `@var`, `@mixin`, `@namespace`, `@listens`, `@fires`,
250252
or `@emits` (these might often be expected to have an accompanying
251-
name path, though they have some indicative value without one)
253+
name path, though they have some indicative value without one; these
254+
may also allow names to be defined in another manner elsewhere in
255+
the block)
252256
* `settings.jsdoc.checkSeesForNamepaths` - Set this to `true` to insist
253257
that `@see` only use name paths (the tag is normally permitted to
254258
allow other text)

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -300,9 +300,13 @@ map will be assumed to be defined.
300300
### Settings to Configure <code>valid-types</code>
301301

302302
* `settings.jsdoc.allowEmptyNamepaths` - Set to `false` to disallow
303-
empty name paths with `@callback`, `@event`, `@listens`, `@fires`,
303+
empty name paths with `@callback`, `@event`, `@class`, `@constructor`,
304+
`@constant`, `@const`, `@function`, `@func`, `@method`, `@interface`,
305+
`@member`, `@var`, `@mixin`, `@namespace`, `@listens`, `@fires`,
304306
or `@emits` (these might often be expected to have an accompanying
305-
name path, though they have some indicative value without one)
307+
name path, though they have some indicative value without one; these
308+
may also allow names to be defined in another manner elsewhere in
309+
the block)
306310
* `settings.jsdoc.checkSeesForNamepaths` - Set this to `true` to insist
307311
that `@see` only use name paths (the tag is normally permitted to
308312
allow other text)

0 commit comments

Comments
 (0)