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

How do I read JSDocs? #2104

Open
VynceMontgomery opened this issue Feb 10, 2024 · 0 comments
Open

How do I read JSDocs? #2104

VynceMontgomery opened this issue Feb 10, 2024 · 0 comments

Comments

@VynceMontgomery
Copy link

As a developer in a project whose documentation is written in JSDoc, I don't know how to make sense of these documents. Not that their docs are badly written, but like I need a "how to read this book" guide to what the different styling and stuff means. For instance, what does it mean when I see "Ƭ" in front of a class name?

Expected behavior

I'd like to see a "how to read these documents" either on the autogenerated document or at least somewhere in the JSDoc site.

Current behavior

I look at the docs and don't know what all the bells & whistles mean.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant