-
Notifications
You must be signed in to change notification settings - Fork 486
Only document exported bindings #515
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
Thinking more about this. Today the input/dependency.js generates a list of all files reachable by @tmcw I would like your input on this topic since you have a better understanding of how everything interacts. |
Instead of traversing over all input files this changes documentExported to traverse from the exports in the input files, loading, parsing and traversing the module specifier as needed. Fixes documentationjs#515
Instead of traversing over all input files this changes documentExported to traverse from the exports in the input files, loading, parsing and traversing the module specifier as needed. Fixes documentationjs#515
* Change document-exported to traverse the code Instead of traversing over all input files this changes documentExported to traverse from the exports in the input files, loading, parsing and traversing the module specifier as needed. Fixes #515 * Move parseToAst to its own module * Skip non export declarations for speed
My use case is that we have an index.js that forwards a bunch of bindings.
Then
a.js
andbaz.js
might depend on other files that have different exported bindings.What we want is to generate documentation for what is in
index.js
. For this--shallow
does not work because we want to keep the jsdoc comments close to the binding declarations (and keeping methods etc in sync would be impossible). Having--shallow=false
does not work either because then all annotated bindings gets exposed, even if they are not exported from index.js.One way to achieve this might be to generate the json for everything and then manipulate that but it seems like this would be a valuable mode to expose.
The text was updated successfully, but these errors were encountered: