-
Notifications
You must be signed in to change notification settings - Fork 482
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
Add a flag to document all exported bindings #490
Conversation
👍 awesome, there's a lint error - I think here - that's making CircleCI quit |
That was not the lint error... See new commit if you care. |
Test is timing out. Maybe I've made test/bin.js too slow by adding one more test to it? 2 observations working on this:
|
If you like #492 then I can simplify these tests to use that. |
|
This adds a boolean flag called `document-exported` (defaults to false) that effectively adds an empty comment to all exported bindings that do not already have a JSDoc comment. It also does the same for the members of exported classes and objects. ```js export class C { method() {} } ``` Both `C` and `C#method` are now part of the generated documentation. Related to documentationjs#424
@tmcw PTAL |
@arv looks great! In terms of:
+1 for creating an interface for extracting comments just like we have one for inference. I don't think the inference interface (ha?) makes sense for extraction, so I wrote #502 which creates an 'extractor' concept and then extracts the two kinds into their own files. It seems to work pretty well - the only weirdness is around addComments, which I inject into the extractors so we don't have to pass arguments everywhere. Thoughts? If you're into it, you can cherry-pick the commit over. |
Merged with #502! |
This adds a boolean flag called
document-exported
(defaults to false)that effectively adds an empty comment to all exported bindings that do
not already have a JSDoc comment. It also does the same for the
members of exported classes and objects.
Both
C
andC#method
are now part of the generated documentation.Related to #424