Skip to content
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

Properties of ES classes not appearing in the output #5

Open
cedx opened this issue Jun 2, 2019 · 0 comments

Comments

Projects
None yet
2 participants
@cedx
Copy link

commented Jun 2, 2019

(sorry to bother you again...)

Using the default template, documenting properties of an ES2015 class is just a matter of adding a @type annotation to each property (whether it's an instance property, an instance getter, or a static getter). Properties appear under the "Members" section.

For the FinderError class in this file:
https://github.com/cedx/which.js/blob/master/lib/finder.js#L137

The default template output is:
Default output

But when using the Tidy template, the "members" section is skipped:
Tidy output

Whatever class property I'm documenting, they never appear in the generated output.
Another example is the static getter Finder.isWindows from the same source file:
https://github.com/cedx/which.js/blob/master/lib/finder.js#L15

It appears in the "Members" section with the default template, but not with the Tidy template.

@julie-ng julie-ng self-assigned this Jun 4, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.