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

Fail to generate links to a class with dots (namespace) in the @class name #547

Open
5 tasks done
fab1o opened this issue Jul 27, 2019 · 2 comments
Open
5 tasks done

Comments

@fab1o
Copy link

fab1o commented Jul 27, 2019

Make sure these boxes are checked before submitting your issue - thank you!
(If your issue is neither a both bug nor a request, please write in a free style)

Short summary of your issue

It fails to generate the HTML a tags (links) for references to a Class with full namespace (with dots). See the example below.

Is there an alternative to solve this?

Input data for reproducing

Configuration

basic configuration using esdoc-standard-plugin and esdoc-ecmascript-proposal-plugin

Codes

/**
 *
 * @class My.Library.Manager
 *
 */
export class Manager {}

/**
 *
 * @class My.Library.Account
 *
 */
export class Account {
    /**
     *
     * @param {My.Library.Manager} manager
     *
     */
    constructor(manager) {}
}

Output data

it should generate the link (a tag) in the Account's constructor but it doesn't.

it does generate correctly when I remove the namespace part "My.Library."

Your environment

  • OS type and version: Mac
  • Node.js version: 10.16.0
  • ESDoc version: 1.0.0
@fab1o fab1o changed the title Fail to generate links to other classes with namespace Fail to generate links to other classes with dots (namespace) Jul 27, 2019
@fab1o fab1o changed the title Fail to generate links to other classes with dots (namespace) Fail to generate links to a class with dots (namespace) in the @class name Jul 27, 2019
@fab1o
Copy link
Author

fab1o commented Jul 27, 2019

I found out the way. Replacing @Class with @typedef

@fab1o fab1o closed this as completed Jul 27, 2019
@fab1o fab1o reopened this Jul 27, 2019
@fab1o
Copy link
Author

fab1o commented Jul 27, 2019

If I use @typedef instead of @Class the link works, but the I loose all the documentation of the class including its method, constructor, etc... Is there a way to have the class and the typedef working at the same time, so I can get the links?

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