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

Render @example JSDoc tag for constructor #600

Open
moreal opened this issue Jun 11, 2024 · 0 comments
Open

Render @example JSDoc tag for constructor #600

moreal opened this issue Jun 11, 2024 · 0 comments

Comments

@moreal
Copy link

moreal commented Jun 11, 2024

Now, it doesn't render @example JSDoc tag for classes' constructors. When to run deno doc --html ./mod.ts && open docs/~/A.html with mod.ts file:

// mod.ts
export class A {
    /**
     * @example Creates an instance.
     * ```
     * new A();
     * ```
     */
    constructor() {}

    /**
     * @example Call a method.
     * ```
     * const a = new A();
     * a.method();
     * ```
     */
    method() {}
}

It can see A.prototype.method's example but it cannot see A.prototype.constructor's example.

No route for A.prototype.constructor

image

It can see A.prototype.method's example at docs/~/A.prototype.method.html

Screenshot 2024-06-11 at 10 54 07 AM
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