fileOverview/file/overview
scottnath opened this issue · 12 comments
Hi dox team,
Looks like the @file tag is not explicitly supported. This means extras like @requires and @author don't get grabbed other than putting that data into the string/html nodes like so:
"tags": [
{
"type": "file",
"string": "Uses Gulpjs and gulp-inject to glob files @author Scott Nath",
"html": "<p>Uses Gulpjs and gulp-inject to glob files @author Scott Nath</p>"
}
],
Am I correct in this assumption?
How difficult would it be to add in functionality for this tag?
thanks,
Scott
Curious, it shouldn't need to be explicitly supported for the author tag to be detected. This sounds like a parsing bug. Could you provide the sample code that produced that output?
No, I mean the code that you ran dox against that produced that output. I wrote my own test using the example on that JSDoc page and Dox is parsing both the file and author tags correctly, so I need to see what is different about your case.
At the top of the gist, I pointed to this file:
https://github.com/pattern-library/pattern-library-utilities/blob/master/lib/get-options.js
Is that what you mean by the code I ran dox against?
ah, yes, thank you. will see what I can find.
I'm able to reproduce it with your sample. It doesn't appear to matter what the tags are, so its definitely something wrong with tag parsing in general.
I see. Can I do anything else to help with this bug?
Wow. Well, I fixed the bug, but that broke a LOT of tests that for some dumb reason were coded to account for that very bug, so it's gonna take me a bit to update all these tests. Might have a fix by end of day, might not.
wow @ChiperSoft thanks so much for being on this!
Disregard previous comment, I was misread my test output. Problem is now fixed, will push out a new release today.
0.8.0 is now published
Thank you for taking care of this.