You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I think this could be solved by including a file-level JSDoc comment at the top of your file :
/**
* Utilities to manage Event Schema Files (.esf files)
* @module utils/esf
*/
/**
* Just a random function.
* @function
* @name f
* @returns {number} The answer to everything.
*/
const f = () => 42;
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) :
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: