Get type info and examples from JSDoc for .js/.mjs files

[lionel-rowe]

Given the following file add.mjs:

// @ts-check

/**
 * @param {number} x - the first number to add
 * @param {number} y - the second number to add
 * @returns {number}
 * 
 * @example
 * ```ts
 * add(1, 2) // 3
 * ```
 */
export function add(x, y) {
    return x + y
}

Running the command deno doc --html --name="Adder" add.mjs

Expected output

add(x: number, y: number): number

Parameters

x: number

• the first number to add

y: number

• the second number to add

Return Type

number

Examples

Example 1

add(1, 2) // 3

Actual output

add(x, y)

Parameters

x

• the first number to add

y

• the second number to add

Return Type

It would be awesome if JSDoc types and @examples were also picked up for .js and .mjs files.

[lionel-rowe]

Oops, wrong repo. Closed in favor of denoland/deno_doc#393, which looks like the same issue.