Skip to content

@file JSDoc tag isn't supported by documentation.js #1366

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

Closed
Quantalabs opened this issue Mar 28, 2021 · 1 comment
Closed

@file JSDoc tag isn't supported by documentation.js #1366

Quantalabs opened this issue Mar 28, 2021 · 1 comment

Comments

@Quantalabs
Copy link

Input Code:

/** @file
 * This is an awesome file that you should use.
 */

const chart = require('Chart.js')

In the above code is in the file index.js, if I run the following command:

documentation build index.js -f > docs/index.md

The markdown output is:

## chart
This is an awesome file that you should use.
..

and not:

This is an awesome file that you should use.
## chart
.. 
  • What version of documentation.js are you using?: 13.2.0
  • How are you running documentation.js (on the CLI, Node.js API, Grunt, other?): CLI
@tmcw
Copy link
Member

tmcw commented Mar 28, 2021

Yes, see the tag support master ticket for the currently supported & unsupported tags: #9

@tmcw tmcw closed this as completed Mar 28, 2021
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

2 participants