eslint-plugin-jsdoc 58.1.1 → 59.0.0

package/src/rules/requireReturns.js

@@ -144,7 +144,7 @@ export default iterateJsdoc(({
   contextDefaults: true,
   meta: {
     docs: {
-      description: 'Requires that returns are documented.',
+      description: 'Requires that returns are documented with `@returns`.',
       url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-returns.md#repos-sticky-header',
     },
     fixable: 'code',
@@ -154,13 +154,34 @@ export default iterateJsdoc(({
         properties: {
           checkConstructors: {
             default: false,
+            description: `A value indicating whether \`constructor\`s should
+be checked for \`@returns\` tags. Defaults to \`false\`.`,
             type: 'boolean',
           },
           checkGetters: {
             default: true,
+            description: `Boolean to determine whether getter methods should
+be checked for \`@returns\` tags. Defaults to \`true\`.`,
             type: 'boolean',
           },
           contexts: {
+            description: `Set this to an array of strings representing the AST context
+(or objects with optional \`context\` and \`comment\` properties) where you wish
+the rule to be applied.
+
+\`context\` defaults to \`any\` and \`comment\` defaults to no specific comment context.
+
+Overrides the default contexts (\`ArrowFunctionExpression\`, \`FunctionDeclaration\`,
+\`FunctionExpression\`). Set to \`"any"\` if you want
+the rule to apply to any JSDoc block throughout your files (as is necessary
+for finding function blocks not attached to a function declaration or
+expression, i.e., \`@callback\` or \`@function\` (or its aliases \`@func\` or
+\`@method\`) (including those associated with an \`@interface\`). This
+rule will only apply on non-default contexts when there is such a tag
+present and the \`forceRequireReturn\` option is set or if the
+\`forceReturnsWithAsync\` option is set with a present \`@async\` tag
+(since we are not checking against the actual \`return\` values in these
+cases).`,
             items: {
               anyOf: [
                 {
@@ -186,9 +207,16 @@ export default iterateJsdoc(({
             type: 'array',
           },
           enableFixer: {
+            description: `Whether to enable the fixer to add a blank \`@returns\`.
+Defaults to \`false\`.`,
             type: 'boolean',
           },
           exemptedBy: {
+            description: `Array of tags (e.g., \`['type']\`) whose presence on the
+document block avoids the need for a \`@returns\`. Defaults to an array
+with \`inheritdoc\`. If you set this array, it will overwrite the default,
+so be sure to add back \`inheritdoc\` if you wish its presence to cause
+exemption of the rule.`,
             items: {
               type: 'string',
             },
@@ -196,13 +224,38 @@ export default iterateJsdoc(({
           },
           forceRequireReturn: {
             default: false,
+            description: `Set to \`true\` to always insist on
+\`@returns\` documentation regardless of implicit or explicit \`return\`'s
+in the function. May be desired to flag that a project is aware of an
+\`undefined\`/\`void\` return. Defaults to \`false\`.`,
             type: 'boolean',
           },
           forceReturnsWithAsync: {
             default: false,
+            description: `By default \`async\` functions that do not explicitly
+return a value pass this rule as an \`async\` function will always return a
+\`Promise\`, even if the \`Promise\` resolves to void. You can force all
+\`async\` functions (including ones with an explicit \`Promise\` but no
+detected non-\`undefined\` \`resolve\` value) to require \`@return\`
+documentation by setting \`forceReturnsWithAsync\` to \`true\` on the options
+object. This may be useful for flagging that there has been consideration
+of return type. Defaults to \`false\`.`,
             type: 'boolean',
           },
           publicOnly: {
+            description: `This option will insist that missing \`@returns\` are only reported for
+function bodies / class declarations that are exported from the module.
+May be a boolean or object. If set to \`true\`, the defaults below will be
+used. If unset, \`@returns\` reporting will not be limited to exports.
+
+This object supports the following optional boolean keys (\`false\` unless
+otherwise noted):
+
+- \`ancestorsOnly\` - Optimization to only check node ancestors to check if node is exported
+- \`esm\` - ESM exports are checked for \`@returns\` JSDoc comments (Defaults to \`true\`)
+- \`cjs\` - CommonJS exports are checked for \`@returns\` JSDoc comments  (Defaults to \`true\`)
+- \`window\` - Window global exports are checked for \`@returns\` JSDoc comments
+`,
             oneOf: [
               {
                 default: false,

package/src/rules/requireReturnsCheck.js

@@ -117,7 +117,7 @@ export default iterateJsdoc(({
 }, {
   meta: {
     docs: {
-      description: 'Requires a return statement in function body if a `@returns` tag is specified in jsdoc comment.',
+      description: 'Requires a return statement in function body if a `@returns` tag is specified in JSDoc comment(and reports if multiple `@returns` tags are present).',
       url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-returns-check.md#repos-sticky-header',
     },
     schema: [
@@ -126,13 +126,34 @@ export default iterateJsdoc(({
         properties: {
           exemptAsync: {
             default: true,
+            description: `By default, functions which return a \`Promise\` that are not
+detected as resolving with a non-\`undefined\` value and \`async\` functions
+(even ones that do not explicitly return a value, as these are returning a
+\`Promise\` implicitly) will be exempted from reporting by this rule.
+If you wish to insist that only \`Promise\`'s which resolve to
+non-\`undefined\` values or \`async\` functions with explicit \`return\`'s will
+be exempted from reporting (i.e., that \`async\` functions can be reported
+if they lack an explicit (non-\`undefined\`) \`return\` when a \`@returns\` is
+present), you can set \`exemptAsync\` to \`false\` on the options object.`,
             type: 'boolean',
           },
           exemptGenerators: {
+            description: `Because a generator might be labeled as having a
+\`IterableIterator\` \`@returns\` value (along with an iterator type
+corresponding to the type of any \`yield\` statements), projects might wish to
+leverage \`@returns\` in generators even without a \`return\` statement. This
+option is therefore \`true\` by default in \`typescript\` mode (in "jsdoc" mode,
+one might be more likely to take advantage of \`@yields\`). Set it to \`false\`
+if you wish for a missing \`return\` to be flagged regardless.`,
             type: 'boolean',
           },
           reportMissingReturnForUndefinedTypes: {
             default: false,
+            description: `If \`true\` and no return or
+resolve value is found, this setting will even insist that reporting occur
+with \`void\` or \`undefined\` (including as an indicated \`Promise\` type).
+Unlike \`require-returns\`, with this option in the rule, one can
+*discourage* the labeling of \`undefined\` types. Defaults to \`false\`.`,
             type: 'boolean',
           },
         },

package/src/rules/requireReturnsDescription.js

@@ -21,7 +21,7 @@ export default iterateJsdoc(({
   contextDefaults: true,
   meta: {
     docs: {
-      description: 'Requires that the `@returns` tag has a `description` value.',
+      description: 'Requires that the `@returns` tag has a `description` value (not including `void`/`undefined` type returns).',
       url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-returns-description.md#repos-sticky-header',
     },
     schema: [
@@ -29,6 +29,20 @@ export default iterateJsdoc(({
         additionalProperties: false,
         properties: {
           contexts: {
+            description: `Set this to an array of strings representing the AST context (or an object with
+optional \`context\` and \`comment\` properties) where you wish the rule to be applied.
+
+\`context\` defaults to \`any\` and \`comment\` defaults to no specific comment context.
+
+Overrides the default contexts (\`ArrowFunctionExpression\`, \`FunctionDeclaration\`,
+\`FunctionExpression\`). Set to \`"any"\` if you want
+the rule to apply to any JSDoc block throughout your files (as is necessary
+for finding function blocks not attached to a function declaration or
+expression, i.e., \`@callback\` or \`@function\` (or its aliases \`@func\` or
+\`@method\`) (including those associated with an \`@interface\`).
+
+See the ["AST and Selectors"](../#advanced-ast-and-selectors)
+section of our Advanced docs for more on the expected format.`,
             items: {
               anyOf: [
                 {

package/src/rules/requireReturnsType.js

@@ -13,7 +13,7 @@ export default iterateJsdoc(({
   contextDefaults: true,
   meta: {
     docs: {
-      description: 'Requires that `@returns` tag has `type` value.',
+      description: 'Requires that `@returns` tag has type value (in curly brackets).',
       url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-returns-type.md#repos-sticky-header',
     },
     schema: [
@@ -21,6 +21,20 @@ export default iterateJsdoc(({
         additionalProperties: false,
         properties: {
           contexts: {
+            description: `Set this to an array of strings representing the AST context (or an object with
+optional \`context\` and \`comment\` properties) where you wish the rule to be applied.
+
+\`context\` defaults to \`any\` and \`comment\` defaults to no specific comment context.
+
+Overrides the default contexts (\`ArrowFunctionExpression\`, \`FunctionDeclaration\`,
+\`FunctionExpression\`). Set to \`"any"\` if you want
+the rule to apply to any JSDoc block throughout your files (as is necessary
+for finding function blocks not attached to a function declaration or
+expression, i.e., \`@callback\` or \`@function\` (or its aliases \`@func\` or
+\`@method\`) (including those associated with an \`@interface\`).
+
+See the ["AST and Selectors"](../#advanced-ast-and-selectors)
+section of our Advanced docs for more on the expected format.`,
             items: {
               anyOf: [
                 {

package/src/rules/requireTemplate.js

@@ -186,7 +186,7 @@ export default iterateJsdoc(({
   iterateAllJsdocs: true,
   meta: {
     docs: {
-      description: 'Requires template tags for each generic type parameter',
+      description: 'Requires `@template` tags be present when type parameters are used.',
       url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-template.md#repos-sticky-header',
     },
     schema: [
@@ -194,12 +194,28 @@ export default iterateJsdoc(({
         additionalProperties: false,
         properties: {
           exemptedBy: {
+            description: `Array of tags (e.g., \`['type']\`) whose presence on the document
+block avoids the need for a \`@template\`. Defaults to an array with
+\`inheritdoc\`. If you set this array, it will overwrite the default,
+so be sure to add back \`inheritdoc\` if you wish its presence to cause
+exemption of the rule.`,
             items: {
               type: 'string',
             },
             type: 'array',
           },
           requireSeparateTemplates: {
+            description: `Requires that each template have its own separate line, i.e., preventing
+templates of this format:
+
+\`\`\`js
+/**
+ * @template T, U, V
+ */
+\`\`\`
+
+Defaults to \`false\`.
+`,
             type: 'boolean',
           },
         },

package/src/rules/requireThrows.js

@@ -67,7 +67,7 @@ export default iterateJsdoc(({
   contextDefaults: true,
   meta: {
     docs: {
-      description: 'Requires that throw statements are documented.',
+      description: 'Requires that throw statements are documented with `@throws` tags.',
       url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-throws.md#repos-sticky-header',
     },
     schema: [
@@ -75,6 +75,18 @@ export default iterateJsdoc(({
         additionalProperties: false,
         properties: {
           contexts: {
+            description: `Set this to an array of strings representing the AST context
+(or objects with optional \`context\` and \`comment\` properties) where you wish
+the rule to be applied.
+
+\`context\` defaults to \`any\` and \`comment\` defaults to no specific comment context.
+
+Overrides the default contexts (\`ArrowFunctionExpression\`, \`FunctionDeclaration\`,
+\`FunctionExpression\`). Set to \`"any"\` if you want
+the rule to apply to any JSDoc block throughout your files (as is necessary
+for finding function blocks not attached to a function declaration or
+expression, i.e., \`@callback\` or \`@function\` (or its aliases \`@func\` or
+\`@method\`) (including those associated with an \`@interface\`).`,
             items: {
               anyOf: [
                 {
@@ -97,6 +109,11 @@ export default iterateJsdoc(({
             type: 'array',
           },
           exemptedBy: {
+            description: `Array of tags (e.g., \`['type']\`) whose presence on the
+document block avoids the need for a \`@throws\`. Defaults to an array
+with \`inheritdoc\`. If you set this array, it will overwrite the default,
+so be sure to add back \`inheritdoc\` if you wish its presence to cause
+exemption of the rule.`,
             items: {
               type: 'string',
             },

package/src/rules/requireYields.js

@@ -152,7 +152,7 @@ export default iterateJsdoc(({
   contextDefaults: true,
   meta: {
     docs: {
-      description: 'Requires yields are documented.',
+      description: 'Requires yields are documented with `@yields` tags.',
       url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-yields.md#repos-sticky-header',
     },
     schema: [
@@ -160,6 +160,23 @@ export default iterateJsdoc(({
         additionalProperties: false,
         properties: {
           contexts: {
+            description: `Set this to an array of strings representing the AST context
+(or objects with optional \`context\` and \`comment\` properties) where you wish
+the rule to be applied.
+
+\`context\` defaults to \`any\` and \`comment\` defaults to no specific comment context.
+
+Overrides the default contexts (\`ArrowFunctionExpression\`, \`FunctionDeclaration\`,
+\`FunctionExpression\`). Set to \`"any"\` if you want
+the rule to apply to any JSDoc block throughout your files (as is necessary
+for finding function blocks not attached to a function declaration or
+expression, i.e., \`@callback\` or \`@function\` (or its aliases \`@func\` or
+\`@method\`) (including those associated with an \`@interface\`). This
+rule will only apply on non-default contexts when there is such a tag
+present and the \`forceRequireYields\` option is set or if the
+\`withGeneratorTag\` option is set with a present \`@generator\` tag
+(since we are not checking against the actual \`yield\` values in these
+cases).`,
             items: {
               anyOf: [
                 {
@@ -182,6 +199,11 @@ export default iterateJsdoc(({
             type: 'array',
           },
           exemptedBy: {
+            description: `Array of tags (e.g., \`['type']\`) whose presence on the
+document block avoids the need for a \`@yields\`. Defaults to an array
+with \`inheritdoc\`. If you set this array, it will overwrite the default,
+so be sure to add back \`inheritdoc\` if you wish its presence to cause
+exemption of the rule.`,
             items: {
               type: 'string',
             },
@@ -189,22 +211,49 @@ export default iterateJsdoc(({
           },
           forceRequireNext: {
             default: false,
+            description: `Set to \`true\` to always insist on
+\`@next\` documentation even if there are no \`yield\` statements in the
+function or none return values. May be desired to flag that a project is
+aware of the expected yield return being \`undefined\`. Defaults to \`false\`.`,
             type: 'boolean',
           },
           forceRequireYields: {
             default: false,
+            description: `Set to \`true\` to always insist on
+\`@yields\` documentation for generators even if there are only
+expressionless \`yield\` statements in the function. May be desired to flag
+that a project is aware of an \`undefined\`/\`void\` yield. Defaults to
+\`false\`.`,
             type: 'boolean',
           },
           next: {
             default: false,
+            description: `If \`true\`, this option will insist that any use of a \`yield\` return
+value (e.g., \`const rv = yield;\` or \`const rv = yield value;\`) has a
+(non-standard) \`@next\` tag (in addition to any \`@yields\` tag) so as to be
+able to document the type expected to be supplied into the iterator
+(the \`Generator\` iterator that is returned by the call to the generator
+function) to the iterator (e.g., \`it.next(value)\`). The tag will not be
+expected if the generator function body merely has plain \`yield;\` or
+\`yield value;\` statements without returning the values. Defaults to
+\`false\`.`,
             type: 'boolean',
           },
           nextWithGeneratorTag: {
             default: false,
+            description: `If a \`@generator\` tag is present on a block, require
+(non-standard ) \`@next\` (see \`next\` option). This will require using \`void\`
+or \`undefined\` in cases where generators do not use the \`next()\`-supplied
+incoming \`yield\`-returned value. Defaults to \`false\`. See \`contexts\` to
+\`any\` if you want to catch \`@generator\` with \`@callback\` or such not
+attached to a function.`,
             type: 'boolean',
           },
           withGeneratorTag: {
             default: true,
+            description: `If a \`@generator\` tag is present on a block, require
+\`@yields\`/\`@yield\`. Defaults to \`true\`. See \`contexts\` to \`any\` if you want
+to catch \`@generator\` with \`@callback\` or such not attached to a function.`,
             type: 'boolean',
           },
         },

package/src/rules/requireYieldsCheck.js

@@ -156,7 +156,7 @@ export default iterateJsdoc(({
 }, {
   meta: {
     docs: {
-      description: 'Requires a yield statement in function body if a `@yields` tag is specified in jsdoc comment.',
+      description: 'Ensures that if a `@yields` is present that a `yield` (or `yield` with a value) is present in the function body (or that if a `@next` is present that there is a yield with a return value present).',
       url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-yields-check.md#repos-sticky-header',
     },
     schema: [
@@ -165,9 +165,22 @@ export default iterateJsdoc(({
         properties: {
           checkGeneratorsOnly: {
             default: false,
+            description: `Avoids checking the function body and merely insists
+that all generators have \`@yields\`. This can be an optimization with the
+ESLint \`require-yield\` rule, as that rule already ensures a \`yield\` is
+present in generators, albeit assuming the generator is not empty).
+Defaults to \`false\`.`,
             type: 'boolean',
           },
           contexts: {
+            description: `Set this to an array of strings representing the AST context
+(or objects with optional \`context\` and \`comment\` properties) where you wish
+the rule to be applied.
+
+\`context\` defaults to \`any\` and \`comment\` defaults to no specific comment context.
+
+Overrides the default contexts (\`ArrowFunctionExpression\`, \`FunctionDeclaration\`,
+\`FunctionExpression\`).`,
             items: {
               anyOf: [
                 {
@@ -189,14 +202,19 @@ export default iterateJsdoc(({
             },
             type: 'array',
           },
-          exemptedBy: {
-            items: {
-              type: 'string',
-            },
-            type: 'array',
-          },
           next: {
             default: false,
+            description: `If \`true\`, this option will insist that any use of a (non-standard)
+\`@next\` tag (in addition to any \`@yields\` tag) will be matched by a \`yield\`
+which uses a return value in the body of the generator (e.g.,
+\`const rv = yield;\` or \`const rv = yield value;\`). This (non-standard)
+tag is intended to be used to indicate a type and/or description of
+the value expected to be supplied by the user when supplied to the iterator
+by its \`next\` method, as with \`it.next(value)\` (with the iterator being
+the \`Generator\` iterator that is returned by the call to the generator
+function). This option will report an error if the generator function body
+merely has plain \`yield;\` or \`yield value;\` statements without returning
+the values. Defaults to \`false\`.`,
             type: 'boolean',
           },
         },

package/src/rules/sortTags.js

@@ -512,7 +512,7 @@ export default iterateJsdoc(({
   iterateAllJsdocs: true,
   meta: {
     docs: {
-      description: 'Sorts tags by a specified sequence according to tag name.',
+      description: 'Sorts tags by a specified sequence according to tag name, optionally adding line breaks between tag groups.',
       url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/sort-tags.md#repos-sticky-header',
     },
     fixable: 'code',
@@ -521,22 +521,221 @@ export default iterateJsdoc(({
         additionalProperties: false,
         properties: {
           alphabetizeExtras: {
+            description: `Defaults to \`false\`. Alphabetizes any items not within \`tagSequence\` after any
+items within \`tagSequence\` (or in place of the special \`-other\` pseudo-tag)
+are sorted.
+
+If you want all your tags alphabetized, you can supply an empty array for
+\`tagSequence\` along with setting this option to \`true\`.`,
             type: 'boolean',
           },
           linesBetween: {
+            description: `Indicates the number of lines to be added between tag groups. Defaults to 1.
+Do not set to 0 or 2+ if you are using \`tag-lines\` and \`"always"\` and do not
+set to 1+ if you are using \`tag-lines\` and \`"never"\`.`,
             type: 'integer',
           },
           reportIntraTagGroupSpacing: {
+            description: `Whether to enable reporting and fixing of line breaks within tags of a given
+tag group. Defaults to \`true\` which will remove any line breaks at the end of
+such tags. Do not use with \`true\` if you are using \`tag-lines\` and \`always\`.`,
             type: 'boolean',
           },
           reportTagGroupSpacing: {
+            description: `Whether to enable reporting and fixing of line breaks between tag groups
+as set by \`linesBetween\`. Defaults to \`true\`. Note that the very last tag
+will not have spacing applied regardless. For adding line breaks there, you
+may wish to use the \`endLines\` option of the \`tag-lines\` rule.`,
             type: 'boolean',
           },
           tagSequence: {
+            description: `An array of tag group objects indicating the preferred sequence for sorting tags.
+
+Each item in the array should be an object with a \`tags\` property set to an array
+of tag names.
+
+Tag names earlier in the list will be arranged first. The relative position of
+tags of the same name will not be changed.
+
+Earlier groups will also be arranged before later groups, but with the added
+feature that additional line breaks may be added between (or before or after)
+such groups (depending on the setting of \`linesBetween\`).
+
+Tag names not in the list will be grouped together at the end. The pseudo-tag
+\`-other\` can be used to place them anywhere else if desired. The tags will be
+placed in their order of appearance, or alphabetized if \`alphabetizeExtras\`
+is enabled, see more below about that option.
+
+Defaults to the array below (noting that it is just a single tag group with
+no lines between groups by default).
+
+Please note that this order is still experimental, so if you want to retain
+a fixed order that doesn't change into the future, supply your own
+\`tagSequence\`.
+
+\`\`\`js
+[{tags: [
+  // Brief descriptions
+  'summary',
+  'typeSummary',
+
+  // Module/file-level
+  'module',
+  'exports',
+  'file',
+  'fileoverview',
+  'overview',
+  'import',
+
+  // Identifying (name, type)
+  'typedef',
+  'interface',
+  'record',
+  'template',
+  'name',
+  'kind',
+  'type',
+  'alias',
+  'external',
+  'host',
+  'callback',
+  'func',
+  'function',
+  'method',
+  'class',
+  'constructor',
+
+  // Relationships
+  'modifies',
+  'mixes',
+  'mixin',
+  'mixinClass',
+  'mixinFunction',
+  'namespace',
+  'borrows',
+  'constructs',
+  'lends',
+  'implements',
+  'requires',
+
+  // Long descriptions
+  'desc',
+  'description',
+  'classdesc',
+  'tutorial',
+  'copyright',
+  'license',
+
+  // Simple annotations
+  'const',
+  'constant',
+  'final',
+  'global',
+  'readonly',
+  'abstract',
+  'virtual',
+  'var',
+  'member',
+  'memberof',
+  'memberof!',
+  'inner',
+  'instance',
+  'inheritdoc',
+  'inheritDoc',
+  'override',
+  'hideconstructor',
+
+  // Core function/object info
+  'param',
+  'arg',
+  'argument',
+  'prop',
+  'property',
+  'return',
+  'returns',
+
+  // Important behavior details
+  'async',
+  'generator',
+  'default',
+  'defaultvalue',
+  'enum',
+  'augments',
+  'extends',
+  'throws',
+  'exception',
+  'yield',
+  'yields',
+  'event',
+  'fires',
+  'emits',
+  'listens',
+  'this',
+
+  // Access
+  'static',
+  'private',
+  'protected',
+  'public',
+  'access',
+  'package',
+
+  '-other',
+
+  // Supplementary descriptions
+  'see',
+  'example',
+
+  // METADATA
+
+  // Other Closure (undocumented) metadata
+  'closurePrimitive',
+  'customElement',
+  'expose',
+  'hidden',
+  'idGenerator',
+  'meaning',
+  'ngInject',
+  'owner',
+  'wizaction',
+
+  // Other Closure (documented) metadata
+  'define',
+  'dict',
+  'export',
+  'externs',
+  'implicitCast',
+  'noalias',
+  'nocollapse',
+  'nocompile',
+  'noinline',
+  'nosideeffects',
+  'polymer',
+  'polymerBehavior',
+  'preserve',
+  'struct',
+  'suppress',
+  'unrestricted',
+
+  // @homer0/prettier-plugin-jsdoc metadata
+  'category',
+
+  // Non-Closure metadata
+  'ignore',
+  'author',
+  'version',
+  'variation',
+  'since',
+  'deprecated',
+  'todo',
+]}];
+\`\`\`
+`,
             items: {
               additionalProperties: false,
               properties: {
                 tags: {
+                  description: 'See description on `tagSequence`.',
                   items: {
                     type: 'string',
                   },