fix(pacmak): '*/' not escaped in JavaDocs #3104
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
If any of the generated JavaDoc contains '*/', that character combination will terminate the doc comment, throwing the Java compiler for a loop. The character combination needs to be escaped. This change makes examples found in the jsii assembly render the same as sample code found in running (MarkDown) text, in doc blocks and READMEs.
nija-at
approved these changes
Oct 28, 2021
| @@ -80,3 +80,18 @@ export class JavaDocRenderer extends MarkdownRenderer { | |||
| function collapseParaJava(x: string) { | |||
| return collapsePara(x, '\n<p>\n'); | |||
| } | |||
|
|
|||
| /** | |||
| * A final single-pass escape of '* /' which might otherwise end a doc comment. | |||
There was a problem hiding this comment.
Suggested change
| * A final single-pass escape of '* /' which might otherwise end a doc comment. | |
| * A final single-pass escape of '*/' which might otherwise end a doc comment. |
There was a problem hiding this comment.
Can't, right, because that would end THIS doc comment
nija-at
added
the
pr/no-squash
rix0rrr
removed
the
pr/no-squash
|
Thank you for contributing! ❤️ I will now look into making sure the PR is up-to-date, then proceed to try and merge it! |
|
Merging (with squash)... |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
If any of the generated JavaDoc contains '*/', that character combination will
terminate the doc comment, throwing the Java compiler for a loop.
The character combination needs to be escaped. This change makes examples found
in the jsii assembly render the same as sample code found in running (MarkDown)
text, in doc blocks and READMEs.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.