jsdoc2md
@file or @overview tags ignored
Summary
jsdoc tags @file and its synonims @overview and @fileoverview seem to be ignored by jsdoc-to-markdown
Steps to reproduce
Create a file with the following contents:
'use strict';
/**
* @file A sample file
*/
/**
* @function foo
*/
function foo () {
return 'bar';
}
Run jsdoc2md:
$ jsdoc2md file.js
<a name="foo"></a>
## foo()
**Kind**: global function
As you can see the contents for the @file tag are not included in the generated markdown.
Other information
Using version 1.3.6. of jsdoc-to-markdown
i don't think this tag gets much usage in jsdoc2md as the information it contains has no impact on a module's API (which is what the tool is intended to document).. But will have a look, thanks.
I there a workaround for this? I need to be able to document files as well.
I figured out a workaround. just use the "@name" tag instead and just give your file a name without an extension. then it will pick up the comments regardless. just don't use "@file" or synonyms or it will still ignore it even when using "@name"
I figured out a workaround. just use the "@name" tag instead and just give your file a name without an extension. then it will pick up the comments regardless. just don't use "@file" or synonyms or it will still ignore it even when using "@name"
This doesn't really seem to be a substitute for @file , it can be used to document a function defined outside the source file, though.
