Fix Javadoc code block formatting #9955
Merged
Conversation
This file contains hidden or 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
|
|
|
Kudos, SonarCloud Quality Gate passed!
|
AutomatedTester
approved these changes
Nov 4, 2021
elgatov
pushed a commit
to elgatov/selenium
that referenced
this pull request
Jun 27, 2022
* Fix Javadoc code block formatting
* Use `<code>` instead of `{code}` and encode '@', '<', and '>'
* Fix flipped closing tags
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.
Description
Several classes use the
<code>tag for for javadoc code blocks. This tag doesn't maintain formatting and should be combined with a<pre>tag (as is done in most classes). Additionally '<', '>', and '@' characters needs to be escaped in plain HTML javadoc.Motivation and Context
The unformatted code blocks result in badly formatted documentation and unescaped characters result broken or incomplete documentation. For instance, the doc for WebDriverDecorator is cut short by an unescaped '@'.
Types of changes
Checklist