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.

Sign up for GitHub

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

Jump to bottom

How to comment entire file using @file #42

Open
Anthony-Gaudino opened this issue Dec 9, 2021 · 1 comment
Open

How to comment entire file using @file #42

Anthony-Gaudino opened this issue Dec 9, 2021 · 1 comment

Comments

@Anthony-Gaudino
Copy link

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
Copy link
Member

75lb commented Aug 27, 2024

@file is currently not supported by jsdoc2md..

@75lb 75lb transferred this issue from jsdoc2md/jsdoc-to-markdown Aug 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@75lb @Anthony-Gaudino