-
Notifications
You must be signed in to change notification settings - Fork 149
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
Missing documentation for classes with constructors #290
Comments
Looks like the issue could be that "memberof" is set to the same as "id" in the class item in the jsdoc template data when you have a constructor. This workaround seems to work for us: Use:
Instead of:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The issue is reproducible on the nlon repo, by running jsdoc2md against packages/nlon/lib/error.mjs, it produces the following output:
The output contains only one class, while the file itself contains multiple. The only thing I've noticed is that
PeerDisconnectedError
has no constructor, while the rest of the classes do. If I pick a class and remove its constructor, the class appears in the output as well.Note that using the --json switch results in info about all the symbols ( not included for brewity ).
Here's the exact commands to replicate, starting from the root of the repo:
cd packages/nlon jsdoc2md -c .jsdoc.js lib/error.mjs jsdoc2md -c .jsdoc.js lib/error.mjs --json
Excellent tool otherwise! Unfortunately this is a deal-breaker for me at the moment, but looking forward to using this in the future.
The text was updated successfully, but these errors were encountered: