-
Notifications
You must be signed in to change notification settings - Fork 486
Option to automatically group files in modules #234
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
Comments
Should follow the guidelines in JSDoc as well for module resolution.
|
Related #183 |
is there another doc generator which can group function/classes/$things into modules? I don't want to show a list with hundreds of functions without any hierarchy or structure. |
It could be this doc generator, if you help out with a PR! |
I wish this too, so far I used the With a drawback, existing groups defined in yml duplicates TOC of that group :( |
Has anyone made any progress on this? As commented on #803 I'd be happy to help, but have no idea where to start. |
I'm a big fan on inferring documentation properties from code: I'm using documentation.js mainly because it allows me to omit the ‘boring’ parts of doc comments by using Flow types. Similarly, since my code uses CommonJS/ES2015 import/exports, I've never seen the value in manually adding JSDoc's
@module
tag to all my files.Thus, I want to suggest a new option for documentation.js: Infer modules from file names.
Let's say I have a
src/foo/bar.js
. Its module name is the same as the name I canrequire()
orimport
it with, i.e.foo/bar
.I'm not sure what your plans for handling modules/grouping documentation items is in general, but for larger projects, I'd like to see a documentation.js theme that lists entries in a tree instead of a flat list.
Ideally, this would also allow me to see which items are exported from a module.
The text was updated successfully, but these errors were encountered: