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

please consider supporting the @readonly tag #570

Open
1 of 5 tasks
bencresty opened this issue Apr 3, 2021 · 0 comments
Open
1 of 5 tasks

please consider supporting the @readonly tag #570

bencresty opened this issue Apr 3, 2021 · 0 comments

Comments

@bencresty
Copy link

bencresty commented Apr 3, 2021

Make sure these boxes are checked before submitting your issue - thank you!
(If your issue is neither a both bug nor a request, please write in a free style)

Short summary of your issue

When using the @readonly tag on for instance a type, it isn't showing up in the docs. With this the doc is missing crucial information for the user to use a lib. Could you please consider supporting this jsDoc tag ( https://jsdoc.app/tags-readonly.html )? It's pretty useful and has a lot of benefits for better docs!

Something like this would be nice to see in the docs (see lock symbol to indicate readonly):

example-of-indication

Input data for reproducing

Codes

/**
 * Current state
 * @type {number}
 * @readonly
 */
this.currentState = 1;

Screen shot of documentation

image

Exception output (if possible)

no exception

Your environment

  • OS type and version: windows
  • Node.js version: 14.15.3
  • ESDoc version: 1.1.0
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