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
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.
The text was updated successfully, but these errors were encountered:
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.
The text was updated successfully, but these errors were encountered: