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.

Sign up for GitHub

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

Jump to bottom

Add enum values to jsdoc output #337

Closed
joeyparrish opened this issue Apr 15, 2016 · 0 comments
Closed

Add enum values to jsdoc output #337

joeyparrish opened this issue Apr 15, 2016 · 0 comments
Assignees
@TheModMaker
Labels
status: archived Archived and locked; will not be updated type: docs Improvements or fixes to documentation
Milestone
v2.0.0

Comments

@joeyparrish
Copy link
Member

The generated docs show enum keys, but not values. Values would be useful.

For example, the docs for shaka.util.Error would be more useful if one could look up an error code 1001 as well as BAD_HTTP_STATUS.

This may require modifications to jsdoc.
@joeyparrish joeyparrish added the type: docs Improvements or fixes to documentation label Apr 15, 2016
@joeyparrish joeyparrish added this to the v2.0.0 milestone Apr 15, 2016
@TheModMaker TheModMaker self-assigned this Apr 19, 2016
@shaka-project shaka-project locked and limited conversation to collaborators Mar 22, 2018
@shaka-bot shaka-bot added the status: archived Archived and locked; will not be updated label Apr 15, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@TheModMaker TheModMaker

Labels
status: archived Archived and locked; will not be updated type: docs Improvements or fixes to documentation
Projects
None yet
Milestone
v2.0.0
Development

No branches or pull requests
3 participants
@TheModMaker @joeyparrish @shaka-bot