question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

valid-jsdoc seems to fail when using @external and @function

See original GitHub issue

What version are you using? ESLint 3.0.1

What did you do?

    /**
     * The jQuery plugin namespace.
     *
     * @external "jQuery.fn"
     * @see {@link http://learn.jquery.com/plugins/|jQuery Plugins}
     */

    // This is a problem...
    // eslint-disable-next-line valid-jsdoc
    /**
     * Creates a {@link BeveragesView} in the selected elements.
     *
     * @function external:"jQuery.fn".beverages
     * @param {Object} options the options for the beverages view
     */

What happened? I had to add eslint-disable.

Removing the line beginning with @function removes the error. Trying synonyms (@func and @method) seems to have no impact. Moving the line around does not fix the error.

I don’t have more information on what makes this JSDoc invalid, so this may be normal but I don’t know what’s wrong.

What did you expect to happen? This should be valid (I think; see JSDoc’s doc).

Issue Analytics

  • State:closed
  • Created 7 years ago
  • Comments:9 (5 by maintainers)

github_iconTop GitHub Comments

1reaction
platinumazurecommented, Jul 16, 2016

Marking as a question for now. Hopefully someone who knows JSDoc on the team will take a look and speak to whether this might be a bug or not.

0reactions
nzakascommented, Oct 1, 2018

Unfortunately, it looks like there wasn’t enough interest from the team or community to implement this change. While we wish we’d be able to accommodate everyone’s requests, we do need to prioritize. We’ve found that issues failing to be implemented after 90 days tend to never be implemented, and as such, we close those issues. This doesn’t mean the idea isn’t interesting or useful, just that it’s not something the team can commit to.

Read more comments on GitHub >

github_iconTop Results From Across the Web

valid-jsdoc - ESLint - Pluggable JavaScript Linter
A pluggable and configurable linter tool for identifying and reporting on patterns in JavaScript. Maintain your code quality with ease.
Read more >
JSDoc for reused Function interface - javascript - Stack Overflow
Is there a valid JSDoc syntax to use @typedef or similar with a Function, where instead of declaring @params and @returns above each...
Read more >
JSDoc: Source: GPUdb.js - Kinetica Docs
Creates a GPUdb API object for the specified URL using the given options. ... function() { got_error = true; failureWrapperCB(new Error("Request timed out") ......
Read more >
Using namepaths with JSDoc 3
A guide to using namepaths with JSDoc 3. ... refer to an inner method when that method isn't directly accessible from outside the...
Read more >
Google JavaScript Style Guide
Dependency} param All external types used in JSDoc * annotations must be goog.require'd, unless declared in externs. */ function someFunction(param) ...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found