eslint-plugin-jsdoc 44.2.3 → 44.2.5

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

@@ -1,128 +1,88 @@
-<a name="user-content-require-property"></a>
-<a name="require-property"></a>
-# <code>require-property</code>
+<a name="user-content-require-property-description"></a>
+<a name="require-property-description"></a>
+# <code>require-property-description</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)
+* [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 all `@typedef` and `@namespace` tags have `@property`
-tags when their type is a plain `object`, `Object`, or `PlainObject`.
+Requires that each `@property` tag has a `description` value.
 
-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>
+<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|`typedef`, `namespace`|
+|Context|everywhere|
+|Tags|`property`|
+|Aliases|`prop`|
 |Recommended|true|
 
-<a name="user-content-require-property-failing-examples"></a>
-<a name="require-property-failing-examples"></a>
+<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 {object} SomeTypedef
+ * @typedef {SomeType} SomeTypedef
+ * @property foo
  */
-// Message: Missing JSDoc @property.
-
-class Test {
-    /**
-     * @typedef {object} SomeTypedef
-     */
-    quux () {}
-}
-// Message: Missing JSDoc @property.
+// Message: Missing JSDoc @property "foo" description.
 
 /**
- * @typedef {PlainObject} SomeTypedef
+ * @typedef {SomeType} SomeTypedef
+ * @prop foo
  */
 // Settings: {"jsdoc":{"tagNamePreference":{"property":"prop"}}}
-// Message: Missing JSDoc @prop.
+// Message: Missing JSDoc @prop "foo" description.
 
 /**
- * @namespace {Object} SomeName
+ * @typedef {SomeType} SomeTypedef
+ * @property foo
  */
-// Message: Missing JSDoc @property.
+// Settings: {"jsdoc":{"tagNamePreference":{"property":false}}}
+// Message: Unexpected tag `@property`
 ````
 
 
 
-<a name="user-content-require-property-passing-examples"></a>
-<a name="require-property-passing-examples"></a>
+<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
 /**
- *
- */
-
-/**
- * @property
- */
-
-/**
- * @typedef {Object} SomeTypedef
- * @property {SomeType} propName Prop description
+ * @typedef {SomeType} SomeTypedef
  */
 
 /**
- * @typedef {object} SomeTypedef
- * @prop {SomeType} propName Prop description
+ * @typedef {SomeType} SomeTypedef
+ * @property foo Foo.
  */
-// Settings: {"jsdoc":{"tagNamePreference":{"property":"prop"}}}
 
 /**
- * @typedef {object} SomeTypedef
- * @property
- * // arbitrary property content
+ * @namespace {SomeType} SomeName
+ * @property foo Foo.
  */
 
 /**
- * @typedef {object<string, string>} SomeTypedef
+ * @class
+ * @property foo Foo.
  */
 
 /**
- * @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.
+ * Typedef with multi-line property type.
+ *
+ * @typedef {object} MyType
+ * @property {function(
+ *   number
+ * )} numberEater Method which takes a number.
  */
-function quux () {
-
-}
 ````
 

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

@@ -1,16 +1,16 @@
-<a name="user-content-require-property-description"></a>
-<a name="require-property-description"></a>
-# <code>require-property-description</code>
+<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-description-context-and-settings)
-* [Failing examples](#user-content-require-property-description-failing-examples)
-* [Passing examples](#user-content-require-property-description-passing-examples)
+* [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 each `@property` tag has a `description` value.
+Requires that all `@property` tags have names.
 
-<a name="user-content-require-property-description-context-and-settings"></a>
-<a name="require-property-description-context-and-settings"></a>
+<a name="user-content-require-property-name-context-and-settings"></a>
+<a name="require-property-name-context-and-settings"></a>
 ## Context and settings
 
 |||
@@ -20,8 +20,8 @@ Requires that each `@property` tag has a `description` value.
 |Aliases|`prop`|
 |Recommended|true|
 
-<a name="user-content-require-property-description-failing-examples"></a>
-<a name="require-property-description-failing-examples"></a>
+<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:
@@ -29,16 +29,15 @@ The following patterns are considered problems:
 ````js
 /**
  * @typedef {SomeType} SomeTypedef
- * @property foo
+ * @property
  */
-// Message: Missing JSDoc @property "foo" description.
+// Message: There must be an identifier after @property type.
 
 /**
  * @typedef {SomeType} SomeTypedef
- * @prop foo
+ * @property {string}
  */
-// Settings: {"jsdoc":{"tagNamePreference":{"property":"prop"}}}
-// Message: Missing JSDoc @prop "foo" description.
+// Message: There must be an identifier after @property tag.
 
 /**
  * @typedef {SomeType} SomeTypedef
@@ -50,8 +49,8 @@ The following patterns are considered problems:
 
 
 
-<a name="user-content-require-property-description-passing-examples"></a>
-<a name="require-property-description-passing-examples"></a>
+<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:
@@ -59,30 +58,22 @@ The following patterns are not considered problems:
 ````js
 /**
  * @typedef {SomeType} SomeTypedef
+ * @property foo
  */
 
 /**
  * @typedef {SomeType} SomeTypedef
- * @property foo Foo.
+ * @property {string} foo
  */
 
 /**
  * @namespace {SomeType} SomeName
- * @property foo Foo.
+ * @property {string} foo
  */
 
 /**
  * @class
- * @property foo Foo.
- */
-
-/**
- * Typedef with multi-line property type.
- *
- * @typedef {object} MyType
- * @property {function(
- *   number
- * )} numberEater Method which takes a number.
+ * @property {string} foo
  */
 ````
 

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

@@ -1,16 +1,16 @@
-<a name="user-content-require-property-name"></a>
-<a name="require-property-name"></a>
-# <code>require-property-name</code>
+<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-name-context-and-settings)
-* [Failing examples](#user-content-require-property-name-failing-examples)
-* [Passing examples](#user-content-require-property-name-passing-examples)
+* [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 all `@property` tags have names.
+Requires that each `@property` tag has a type value (within curly brackets).
 
-<a name="user-content-require-property-name-context-and-settings"></a>
-<a name="require-property-name-context-and-settings"></a>
+<a name="user-content-require-property-type-context-and-settings"></a>
+<a name="require-property-type-context-and-settings"></a>
 ## Context and settings
 
 |||
@@ -20,8 +20,8 @@ Requires that all `@property` tags have names.
 |Aliases|`prop`|
 |Recommended|true|
 
-<a name="user-content-require-property-name-failing-examples"></a>
-<a name="require-property-name-failing-examples"></a>
+<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:
@@ -29,15 +29,16 @@ The following patterns are considered problems:
 ````js
 /**
  * @typedef {SomeType} SomeTypedef
- * @property
+ * @property foo
  */
-// Message: There must be an identifier after @property type.
+// Message: Missing JSDoc @property "foo" type.
 
 /**
  * @typedef {SomeType} SomeTypedef
- * @property {string}
+ * @prop foo
  */
-// Message: There must be an identifier after @property tag.
+// Settings: {"jsdoc":{"tagNamePreference":{"property":"prop"}}}
+// Message: Missing JSDoc @prop "foo" type.
 
 /**
  * @typedef {SomeType} SomeTypedef
@@ -49,8 +50,8 @@ The following patterns are considered problems:
 
 
 
-<a name="user-content-require-property-name-passing-examples"></a>
-<a name="require-property-name-passing-examples"></a>
+<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:
@@ -58,22 +59,21 @@ The following patterns are not considered problems:
 ````js
 /**
  * @typedef {SomeType} SomeTypedef
- * @property foo
  */
 
 /**
  * @typedef {SomeType} SomeTypedef
- * @property {string} foo
+ * @property {number} foo
  */
 
 /**
  * @namespace {SomeType} SomeName
- * @property {string} foo
+ * @property {number} foo
  */
 
 /**
  * @class
- * @property {string} foo
+ * @property {number} foo
  */
 ````
 

package/docs/rules/require-property.md

@@ -1,79 +1,128 @@
-<a name="user-content-require-property-type"></a>
-<a name="require-property-type"></a>
-# <code>require-property-type</code>
+<a name="user-content-require-property"></a>
+<a name="require-property"></a>
+# <code>require-property</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)
+* [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 each `@property` tag has a type value (within curly brackets).
+Requires that all `@typedef` and `@namespace` tags have `@property`
+tags when their type is a plain `object`, `Object`, or `PlainObject`.
 
-<a name="user-content-require-property-type-context-and-settings"></a>
-<a name="require-property-type-context-and-settings"></a>
+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|`property`|
-|Aliases|`prop`|
+|Context|Everywhere|
+|Tags|`typedef`, `namespace`|
 |Recommended|true|
 
-<a name="user-content-require-property-type-failing-examples"></a>
-<a name="require-property-type-failing-examples"></a>
+<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 {SomeType} SomeTypedef
- * @property foo
+ * @typedef {object} SomeTypedef
  */
-// Message: Missing JSDoc @property "foo" type.
+// Message: Missing JSDoc @property.
+
+class Test {
+    /**
+     * @typedef {object} SomeTypedef
+     */
+    quux () {}
+}
+// Message: Missing JSDoc @property.
 
 /**
- * @typedef {SomeType} SomeTypedef
- * @prop foo
+ * @typedef {PlainObject} SomeTypedef
  */
 // Settings: {"jsdoc":{"tagNamePreference":{"property":"prop"}}}
-// Message: Missing JSDoc @prop "foo" type.
+// Message: Missing JSDoc @prop.
 
 /**
- * @typedef {SomeType} SomeTypedef
- * @property foo
+ * @namespace {Object} SomeName
  */
-// Settings: {"jsdoc":{"tagNamePreference":{"property":false}}}
-// Message: Unexpected tag `@property`
+// Message: Missing JSDoc @property.
 ````
 
 
 
-<a name="user-content-require-property-type-passing-examples"></a>
-<a name="require-property-type-passing-examples"></a>
+<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
 /**
- * @typedef {SomeType} SomeTypedef
+ *
+ */
+
+/**
+ * @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
  */
 
 /**
- * @typedef {SomeType} SomeTypedef
- * @property {number} foo
+ * @namespace {object} SomeName
+ * @property {SomeType} propName Prop description
  */
 
 /**
- * @namespace {SomeType} SomeName
- * @property {number} foo
+ * @namespace {object} SomeName
+ * @property
+ * // arbitrary property content
  */
 
 /**
- * @class
- * @property {number} foo
+ * @typedef {object} SomeTypedef
+ * @property someProp
+ * @property anotherProp This with a description
+ * @property {anotherType} yetAnotherProp This with a type and desc.
  */
+function quux () {
+
+}
 ````