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

Private class properties with the same name as public properties fail to be handled when both have jsdoc #242

Open
Standard8 opened this issue Jul 10, 2024 · 0 comments

Comments

@Standard8
Copy link
Member

Standard8 commented Jul 10, 2024

With this code:

class foo {
  /**
   * My doc
   */
  #bar = [];

  /**
   * My other doc.
   * @param {array} values
   */
  set bar(values) {
    this.#bar = values;
  }

sphinx-js fails with:

sphinx_js.suffix_tree.PathsTaken: Your code contains multiple documented objects at each of these paths:

  ./myfile.foo#bar

We won't know which one you're talking about.

If I change the name of the setter or the private variable, then sphinx-js works.

@Standard8 Standard8 changed the title Private class properties with the same name as public properties fail to be handled Private class properties with the same name as public properties fail to be handled when both have jsdoc Oct 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant