eslint/doctrine

Support quotes in @function external:"myexternal".myFunction

cyChop opened this issue · 2 comments

What version are you using?

1.2.2 (ESLint 3.0.1)

What JSDoc comment were you trying to parse?

    /**
     * Creates a {@link BeveragesView} in the selected elements.
     *
     * @function external:"jQuery.fn".beverages
     * @param {Object} options the options for the beverages view
     */

What Doctrine options were you using (sloppy, unwrap, etc.)?

Don't know, used by ESLint for validating the valid-jsdoc rule.

What happened? Include output if possible.

ESLint fails to validate the valid-jsdoc rule. Output is:

X:\some\path\beverages.js
  21:5  error  JSDoc syntax error  valid-jsdoc

Removing the quotes seems to fix the problem of parsing, but the documented function then disappears from the generated documentation.

What did you expect to happen?

The code was supposed to be valid. It is largely inspired (almost directly copied) from JSDoc's own documentation and examples.

tmcw commented

My bug PR describes the same problem as this: #165

Thanks for this issue. We have decided to officially end-of-life JSDoc support in ESLint. As a result, this repository and project will no longer be maintained.

Thanks for understanding and we apologize for any inconvenience.