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'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 this
Obviously 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 appfoobar 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:
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'.
I'm not 100% certain what you're trying to achieve so can't yet give you a precise answer on how to achieve it.. Could you post a gist or similar of actual source code along with the command I should run to see your issue? I'm guessing you will need to make use of @alias..
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: