-
-
Notifications
You must be signed in to change notification settings - Fork 153
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Allow require-param-*
and require-returns-description
/require-returns-type
/require-returns
rules to check @callback
and @function
tags
#406
Labels
Comments
brettz9
changed the title
Allow
Allow Oct 20, 2019
require-param-*
rules to check @callback
tagsrequire-param-*
and require-returns-description
/require-returns-type
/require-returns
rules to check @callback
tags
brettz9
changed the title
Allow
Allow Oct 20, 2019
require-param-*
and require-returns-description
/require-returns-type
/require-returns
rules to check @callback
tagsrequire-param-*
and require-returns-description
/require-returns-type
/require-returns
rules to check @callback
and @function
tags
brettz9
added a commit
to brettz9/eslint-plugin-jsdoc
that referenced
this issue
Dec 29, 2019
brettz9
added a commit
to brettz9/eslint-plugin-jsdoc
that referenced
this issue
Dec 29, 2019
brettz9
added a commit
to brettz9/eslint-plugin-jsdoc
that referenced
this issue
Dec 29, 2019
…ws `contexts` option to be set to "any" to check virtual function docs like `@callback` or `@function` with `@interface`; fixes gajus#406
brettz9
added a commit
to brettz9/eslint-plugin-jsdoc
that referenced
this issue
Dec 29, 2019
brettz9
added a commit
to brettz9/eslint-plugin-jsdoc
that referenced
this issue
Dec 29, 2019
…ws `contexts` option to be set to "any" to check virtual function docs like `@callback` or `@function` with `@interface`; fixes gajus#406
brettz9
added a commit
to brettz9/eslint-plugin-jsdoc
that referenced
this issue
Dec 29, 2019
brettz9
added a commit
to brettz9/eslint-plugin-jsdoc
that referenced
this issue
Dec 29, 2019
…ws `contexts` option to be set to "any" to check virtual function docs like `@callback` or `@function` with `@interface`; fixes gajus#406
brettz9
added a commit
to brettz9/eslint-plugin-jsdoc
that referenced
this issue
Dec 29, 2019
brettz9
added a commit
to brettz9/eslint-plugin-jsdoc
that referenced
this issue
Dec 29, 2019
…ws `contexts` option to be set to "any" to check virtual function docs like `@callback` or `@function` with `@interface`; fixes gajus#406
brettz9
added a commit
to brettz9/eslint-plugin-jsdoc
that referenced
this issue
Dec 31, 2019
brettz9
added a commit
to brettz9/eslint-plugin-jsdoc
that referenced
this issue
Dec 31, 2019
…ws `contexts` option to be set to "any" to check virtual function docs like `@callback` or `@function` with `@interface`; fixes gajus#406
brettz9
added a commit
to brettz9/eslint-plugin-jsdoc
that referenced
this issue
Dec 31, 2019
brettz9
added a commit
to brettz9/eslint-plugin-jsdoc
that referenced
this issue
Dec 31, 2019
…ws `contexts` option to be set to "any" to check virtual function docs like `@callback` or `@function` with `@interface`; fixes gajus#406
brettz9
added a commit
to brettz9/eslint-plugin-jsdoc
that referenced
this issue
Dec 31, 2019
brettz9
added a commit
to brettz9/eslint-plugin-jsdoc
that referenced
this issue
Dec 31, 2019
…ws `contexts` option to be set to "any" to check virtual function docs like `@callback` or `@function` with `@interface`; fixes gajus#406
brettz9
added a commit
to brettz9/eslint-plugin-jsdoc
that referenced
this issue
Dec 31, 2019
brettz9
added a commit
to brettz9/eslint-plugin-jsdoc
that referenced
this issue
Dec 31, 2019
…ws `contexts` option to be set to "any" to check virtual function docs like `@callback` or `@function` with `@interface`; fixes gajus#406
🎉 This issue has been resolved in version 19.1.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The
@callback
tag has no associated context, so it would need to be checked throughout the file, but although we can't checkrequire-param
if we don't know the JavaScript function to which it applies, we can at least checkrequire-param-name
,require-param-type
, andrequire-param-description
if enabled for this tag.Similarly, we can apply
require-returns-description
/require-returns-type
and a modified form ofrequire-returns
(i.e., likeforceRequireReturn
which, if enabled, always checks its presence);require-returns-check
would not be applicable.The
@function
tag is mentioned here since in the case of@interface
functions, these may not appear above an actual JavaScript function. See https://jsdoc.app/tags-interface.html .The text was updated successfully, but these errors were encountered: