Skip to content
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

@return unavailable in closurecompiler? #76

Closed
Deathspike opened this issue Dec 27, 2014 · 2 comments
Closed

@return unavailable in closurecompiler? #76

Deathspike opened this issue Dec 27, 2014 · 2 comments

Comments

@Deathspike
Copy link

I have a declaration like this:

/**
 * Creates a processor.
 * @param {!IOptions} options
 * @param {!ISeries} series
 * @param {!IChapter} chapter
 * @return {IProcessor}
 */

With the following settings:

"jsDoc": {
  "checkAnnotations": "closurecompiler",
  "checkParamNames": true,
  "checkRedundantAccess": true,
  "checkRedundantParams": true,
  "checkRedundantReturns": true,
  "checkReturnTypes": true,
  "checkTypes": "strictNativeCase",
  "enforceExistence": true,
  "leadingUnderscoreAccess": true,
  "requireParamTypes": true,
  "requireReturnTypes": true
},

And I get a warning that @returnis unavailable. It should be@return, not@returns` for closure.

@qfox
Copy link
Member

qfox commented Dec 27, 2014

Thanks! Looking at it.

@qfox qfox added the bug label Dec 27, 2014
qfox pushed a commit that referenced this issue Dec 28, 2014
qfox pushed a commit that referenced this issue Dec 28, 2014
@qfox qfox closed this as completed in cd04f56 Dec 28, 2014
@qfox
Copy link
Member

qfox commented Dec 28, 2014

According to closurecompiler docs it allows jsdoc-toolkit. So I can't deny @returns tag right now.

I'll patching googleclosure tag preset. Tell me about your feels with new preset, how it fills your needs?

Thanks again!

p.s. Please tune it out using "extra": { ... } while using and send the result to us to discuss more precisely. It will be really good to have some feedback.

To use "extra" you should patch your .jscsrc:

"jsDoc": {
  "checkAnnotations": {
    "preset": "closurecompiler",
    "extra": {
      "patchingTag": true // it can be true to allow, false to allow without values, and "some" to force some value
    }
  }

@qfox qfox added the tag sets label Jan 25, 2015
jdlrobson pushed a commit to jdlrobson/jscs-jsdoc that referenced this issue Aug 21, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants