How to comment entire file using @file

jsdoc2md / jsdoc-parse

parses jsdoc documentation from javascript or html files, outputs JSON

MIT License

99 stars 19 forks source link

Open Anthony-Gaudino opened 2 years ago

Anthony-Gaudino commented 2 years ago

When I add a @file comment to a file, it doesn't show in the Markdown.

Example:

/**
 * @file This is my file comment.
 */

/**
 * This is my funciton.
 */
function a() {
}

Is @file not supported?

75lb commented 2 months ago

@file is currently not supported by jsdoc2md..