9 comments Labels. @param tag is used to tag a parameter types to a function or method. We get a lot of issues, so this message is automatically posted to each one to help you check that you've included all of the information we need to help you.Including this information in your issue helps us to triage it and get you a response as quickly as possible.What's the difference? This installs jsdoc package in a global location. If the return type is undefined I don't need a return statement in the code.This plugin should concern itself with JSDoc — not with the code style! And so are big reports, and here is one.It's no PR, but might be helpful. You can define the type at one point in your source and use it as a type for @param or @returns or other JSDoc tags that can make use of a type. accepted archived due to age blocked enhancement rule. 20. GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.By clicking “Sign up for GitHub”, you agree to our Thanks for the issue! Comments . This plugin should concern itself with JSDoc — not with the code style! This is the change I made to work around this bug and get my code validating:Lots of the core ESLint rules seem to have a configurable options object to enable/disable parts of a rule, As this rule has 2 report() cases maybe it would be logical to allow them to be enabled separately?Lots of the core ESLint rules seem to have a configurable options object to enable/disable parts of a rule, As this rule has 2 report() cases maybe it would be logical to allow them to be enabled separately?I would hope that this behavior could made optional because I personally Successfully merging a pull request may close this issue. Present JSDoc @returns declaration but not available return expression in function jsdoc/require-returns I should not get. Ask Question Asked 7 years, 6 months ago. "require-returns" requires useless return statements for return type "undefined" Viewed 62k times 105. Why can't you just change it to or are you going to tell me to use one of the existing options?Successfully merging a pull request may close this issue. valid-jsdoc: Return to accept `undefined` type Active 1 year, 2 months ago. This commit was created on GitHub.com and signed with a

Copy link Quote reply Member gyandeeps commented Aug 12, 2015. It is clear how to document the parameter types for many_prompts, but what is the right way to document the function it returns? GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.By clicking “Sign up for GitHub”, you agree to our Subject says it.
I am using JSDoc for parameter documentation. I ... @returns {void} returns nothing @returns {undefined} returns undefiend What are valid param tag types in jsdoc? The return type when there is no return statement is undefined, so describing such a function as having @returns {undefined} is 100% correct.

How to specify an array of objects as a parameter or return value in JSDoc? The return type when there is no Sure, always.