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
How to group ES2015 modules? #284
Comments
OK so I figured out I needed to actually provide the entire collection of .mjs/js files... but I'm still having a hard time figuring out how to group these modules in a parent/child relationship like I did natively with a single object containing all the 'modules'.
|
if I use |
I'm in the process of converting a major project from a single monstrous JS file using a namespaced object to ES2015, and as a result it totally broke JSDoc generation.
This is my current npm run script (I've excluded a large list of custom partials for readability)
npx jsdoc-to-markdown -c jsdoc.conf --private --heading-depth 1 --files src/core/init.mjs > docs/reference-core.html
init.mjs
is my entry point and pretty much looks like thisObviously generating documentation for any imported module makes no sense when using 3rd party libraries, is there a way to document which imported modules are part of the project so their documentation is automatically pulled in?
What's the secret jsdoc recipe to generate a single page of documentation for
app
foo
bar
etc...? I used to@namespace
religiously which worked perfectly for a large object but nothing seems to be pulled in...The text was updated successfully, but these errors were encountered: