docs: Add support for documenting top-level enums #4498
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Previously, top-level enums caused the generation of filenames like "shaka.config.html#AutoShowText" instead of "shaka.config.AutoShowText.html". This broke the generation of docs for top-level enums (attached to a namespace instead of a class). This adds support for these into our jsdoc template.
theodab
approved these changes
Sep 20, 2022
|
Incremental code coverage: No instrumented code was changed. |
JulianDomingo
pushed a commit
that referenced
this pull request
Oct 6, 2022
Previously, top-level enums caused the generation of filenames like "shaka.config.html#AutoShowText" instead of "shaka.config.AutoShowText.html". This broke the generation of docs for top-level enums (attached to a namespace instead of a class). This adds support for these into our jsdoc template. Related to PR #3421
JulianDomingo
pushed a commit
that referenced
this pull request
Oct 6, 2022
Previously, top-level enums caused the generation of filenames like "shaka.config.html#AutoShowText" instead of "shaka.config.AutoShowText.html". This broke the generation of docs for top-level enums (attached to a namespace instead of a class). This adds support for these into our jsdoc template. Related to PR #3421
JulianDomingo
pushed a commit
that referenced
this pull request
Oct 7, 2022
Previously, top-level enums caused the generation of filenames like "shaka.config.html#AutoShowText" instead of "shaka.config.AutoShowText.html". This broke the generation of docs for top-level enums (attached to a namespace instead of a class). This adds support for these into our jsdoc template. Related to PR #3421
JulianDomingo
pushed a commit
that referenced
this pull request
Oct 7, 2022
Previously, top-level enums caused the generation of filenames like "shaka.config.html#AutoShowText" instead of "shaka.config.AutoShowText.html". This broke the generation of docs for top-level enums (attached to a namespace instead of a class). This adds support for these into our jsdoc template. Related to PR #3421
github-actions
bot
added
the
status: archived
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Previously, top-level enums caused the generation of filenames like "shaka.config.html#AutoShowText" instead of
"shaka.config.AutoShowText.html". This broke the generation of docs for top-level enums (attached to a namespace instead of a class).
This adds support for these into our jsdoc template.
Related to PR #3421