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
File-level comments misapplied #1384
Comments
I think this could be solved by including a file-level JSDoc comment at the top of your file :
When you run the documentation command to generate documentation, you should include the file or files that you want to generate documentation for(like for example esf.js) : "documentation build --github --markdown-toc --config documentation.yml -f html src/utils/esf.js -o docs/jsDocumentation" When the documentation is generated, the file-level JSDoc comment will appear at the top of the generated documentation, and the function-level comments will appear in their respective sections. |
Using Documentation 13.2.5 and running it through yarn with the command
"documentation build --github --markdown-toc --config documentation.yml -f html src/utils/** -o docs/jsDocumentation"
I want to supply file-level documentation. My source file has:
The file comments are applied to a ghost second copy of
f
:The text was updated successfully, but these errors were encountered: