eslint-plugin-jsdoc 46.4.6 → 46.5.1

package/docs/rules/require-property-description.md

@@ -1,88 +0,0 @@
-<a name="user-content-require-property-description"></a>
-<a name="require-property-description"></a>
-# <code>require-property-description</code>
-
-* [Context and settings](#user-content-require-property-description-context-and-settings)
-* [Failing examples](#user-content-require-property-description-failing-examples)
-* [Passing examples](#user-content-require-property-description-passing-examples)
-
-
-Requires that each `@property` tag has a `description` value.
-
-<a name="user-content-require-property-description-context-and-settings"></a>
-<a name="require-property-description-context-and-settings"></a>
-## Context and settings
-
-|||
-|---|---|
-|Context|everywhere|
-|Tags|`property`|
-|Aliases|`prop`|
-|Recommended|true|
-
-<a name="user-content-require-property-description-failing-examples"></a>
-<a name="require-property-description-failing-examples"></a>
-## Failing examples
-
-The following patterns are considered problems:
-
-````js
-/**
- * @typedef {SomeType} SomeTypedef
- * @property foo
- */
-// Message: Missing JSDoc @property "foo" description.
-
-/**
- * @typedef {SomeType} SomeTypedef
- * @prop foo
- */
-// Settings: {"jsdoc":{"tagNamePreference":{"property":"prop"}}}
-// Message: Missing JSDoc @prop "foo" description.
-
-/**
- * @typedef {SomeType} SomeTypedef
- * @property foo
- */
-// Settings: {"jsdoc":{"tagNamePreference":{"property":false}}}
-// Message: Unexpected tag `@property`
-````
-
-
-
-<a name="user-content-require-property-description-passing-examples"></a>
-<a name="require-property-description-passing-examples"></a>
-## Passing examples
-
-The following patterns are not considered problems:
-
-````js
-/**
- * @typedef {SomeType} SomeTypedef
- */
-
-/**
- * @typedef {SomeType} SomeTypedef
- * @property foo Foo.
- */
-
-/**
- * @namespace {SomeType} SomeName
- * @property foo Foo.
- */
-
-/**
- * @class
- * @property foo Foo.
- */
-
-/**
- * Typedef with multi-line property type.
- *
- * @typedef {object} MyType
- * @property {function(
- *   number
- * )} numberEater Method which takes a number.
- */
-````
-

package/docs/rules/require-property-name.md

@@ -1,79 +0,0 @@
-<a name="user-content-require-property-name"></a>
-<a name="require-property-name"></a>
-# <code>require-property-name</code>
-
-* [Context and settings](#user-content-require-property-name-context-and-settings)
-* [Failing examples](#user-content-require-property-name-failing-examples)
-* [Passing examples](#user-content-require-property-name-passing-examples)
-
-
-Requires that all `@property` tags have names.
-
-<a name="user-content-require-property-name-context-and-settings"></a>
-<a name="require-property-name-context-and-settings"></a>
-## Context and settings
-
-|||
-|---|---|
-|Context|everywhere|
-|Tags|`property`|
-|Aliases|`prop`|
-|Recommended|true|
-
-<a name="user-content-require-property-name-failing-examples"></a>
-<a name="require-property-name-failing-examples"></a>
-## Failing examples
-
-The following patterns are considered problems:
-
-````js
-/**
- * @typedef {SomeType} SomeTypedef
- * @property
- */
-// Message: There must be an identifier after @property type.
-
-/**
- * @typedef {SomeType} SomeTypedef
- * @property {string}
- */
-// Message: There must be an identifier after @property tag.
-
-/**
- * @typedef {SomeType} SomeTypedef
- * @property foo
- */
-// Settings: {"jsdoc":{"tagNamePreference":{"property":false}}}
-// Message: Unexpected tag `@property`
-````
-
-
-
-<a name="user-content-require-property-name-passing-examples"></a>
-<a name="require-property-name-passing-examples"></a>
-## Passing examples
-
-The following patterns are not considered problems:
-
-````js
-/**
- * @typedef {SomeType} SomeTypedef
- * @property foo
- */
-
-/**
- * @typedef {SomeType} SomeTypedef
- * @property {string} foo
- */
-
-/**
- * @namespace {SomeType} SomeName
- * @property {string} foo
- */
-
-/**
- * @class
- * @property {string} foo
- */
-````
-

package/docs/rules/require-property-type.md

@@ -1,79 +0,0 @@
-<a name="user-content-require-property-type"></a>
-<a name="require-property-type"></a>
-# <code>require-property-type</code>
-
-* [Context and settings](#user-content-require-property-type-context-and-settings)
-* [Failing examples](#user-content-require-property-type-failing-examples)
-* [Passing examples](#user-content-require-property-type-passing-examples)
-
-
-Requires that each `@property` tag has a type value (within curly brackets).
-
-<a name="user-content-require-property-type-context-and-settings"></a>
-<a name="require-property-type-context-and-settings"></a>
-## Context and settings
-
-|||
-|---|---|
-|Context|everywhere|
-|Tags|`property`|
-|Aliases|`prop`|
-|Recommended|true|
-
-<a name="user-content-require-property-type-failing-examples"></a>
-<a name="require-property-type-failing-examples"></a>
-## Failing examples
-
-The following patterns are considered problems:
-
-````js
-/**
- * @typedef {SomeType} SomeTypedef
- * @property foo
- */
-// Message: Missing JSDoc @property "foo" type.
-
-/**
- * @typedef {SomeType} SomeTypedef
- * @prop foo
- */
-// Settings: {"jsdoc":{"tagNamePreference":{"property":"prop"}}}
-// Message: Missing JSDoc @prop "foo" type.
-
-/**
- * @typedef {SomeType} SomeTypedef
- * @property foo
- */
-// Settings: {"jsdoc":{"tagNamePreference":{"property":false}}}
-// Message: Unexpected tag `@property`
-````
-
-
-
-<a name="user-content-require-property-type-passing-examples"></a>
-<a name="require-property-type-passing-examples"></a>
-## Passing examples
-
-The following patterns are not considered problems:
-
-````js
-/**
- * @typedef {SomeType} SomeTypedef
- */
-
-/**
- * @typedef {SomeType} SomeTypedef
- * @property {number} foo
- */
-
-/**
- * @namespace {SomeType} SomeName
- * @property {number} foo
- */
-
-/**
- * @class
- * @property {number} foo
- */
-````
-

package/docs/rules/require-property.md

@@ -1,128 +0,0 @@
-<a name="user-content-require-property"></a>
-<a name="require-property"></a>
-# <code>require-property</code>
-
-* [Fixer](#user-content-require-property-fixer)
-* [Context and settings](#user-content-require-property-context-and-settings)
-* [Failing examples](#user-content-require-property-failing-examples)
-* [Passing examples](#user-content-require-property-passing-examples)
-
-
-Requires that all `@typedef` and `@namespace` tags have `@property`
-tags when their type is a plain `object`, `Object`, or `PlainObject`.
-
-Note that any other type, including a subtype of object such as
-`object<string, string>`, will not be reported.
-
-<a name="user-content-require-property-fixer"></a>
-<a name="require-property-fixer"></a>
-## Fixer
-
-The fixer for `require-property` will add an empty `@property`.
-
-<a name="user-content-require-property-context-and-settings"></a>
-<a name="require-property-context-and-settings"></a>
-## Context and settings
-
-|||
-|---|---|
-|Context|Everywhere|
-|Tags|`typedef`, `namespace`|
-|Recommended|true|
-
-<a name="user-content-require-property-failing-examples"></a>
-<a name="require-property-failing-examples"></a>
-## Failing examples
-
-The following patterns are considered problems:
-
-````js
-/**
- * @typedef {object} SomeTypedef
- */
-// Message: Missing JSDoc @property.
-
-class Test {
-    /**
-     * @typedef {object} SomeTypedef
-     */
-    quux () {}
-}
-// Message: Missing JSDoc @property.
-
-/**
- * @typedef {PlainObject} SomeTypedef
- */
-// Settings: {"jsdoc":{"tagNamePreference":{"property":"prop"}}}
-// Message: Missing JSDoc @prop.
-
-/**
- * @namespace {Object} SomeName
- */
-// Message: Missing JSDoc @property.
-````
-
-
-
-<a name="user-content-require-property-passing-examples"></a>
-<a name="require-property-passing-examples"></a>
-## Passing examples
-
-The following patterns are not considered problems:
-
-````js
-/**
- *
- */
-
-/**
- * @property
- */
-
-/**
- * @typedef {Object} SomeTypedef
- * @property {SomeType} propName Prop description
- */
-
-/**
- * @typedef {object} SomeTypedef
- * @prop {SomeType} propName Prop description
- */
-// Settings: {"jsdoc":{"tagNamePreference":{"property":"prop"}}}
-
-/**
- * @typedef {object} SomeTypedef
- * @property
- * // arbitrary property content
- */
-
-/**
- * @typedef {object<string, string>} SomeTypedef
- */
-
-/**
- * @typedef {string} SomeTypedef
- */
-
-/**
- * @namespace {object} SomeName
- * @property {SomeType} propName Prop description
- */
-
-/**
- * @namespace {object} SomeName
- * @property
- * // arbitrary property content
- */
-
-/**
- * @typedef {object} SomeTypedef
- * @property someProp
- * @property anotherProp This with a description
- * @property {anotherType} yetAnotherProp This with a type and desc.
- */
-function quux () {
-
-}
-````
-