denoland / deno_doc

Documentation generator for Deno
MIT License
253 stars 54 forks source link

Render `@example` JSDoc tag for constructor #600

Open moreal opened 3 months ago

moreal commented 3 months ago

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