documentationjs/documentation

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

Quantalabs opened this issue · 1 comments

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 commented

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