You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The issue is reproducible on the nlon repo, by running jsdoc2md against packages/nlon/lib/error.mjs, it produces the following output:
<a name="PeerDisconnectedError"></a>
## PeerDisconnectedError
<p>Error thrown when trying to send / receive on a peer that's already
disconnected.</p>
**Kind**: global class
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:
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:
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: