Issue #18570: Add new PreferJavadocInlineTagsCheck#18906
Open
vivek-0509 wants to merge 1 commit intocheckstyle:masterfrom
Open
Issue #18570: Add new PreferJavadocInlineTagsCheck#18906vivek-0509 wants to merge 1 commit intocheckstyle:masterfrom
vivek-0509 wants to merge 1 commit intocheckstyle:masterfrom
Conversation
Contributor
Author
|
GitHub, generate report |
95f5915 to
fb5a109
Compare
Contributor
Author
|
@romani https://checkstyle.semaphoreci.com/jobs/139cba1a-3511-43c2-ac89-6dab0b03c85c |
Contributor
Author
|
@romani ping |
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
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.
Issue #18570:
Adds a new Javadoc check
PreferJavadocInlineTagsthat enforces the use of Javadoc inline tags over their HTML equivalents, as recommended by OpenJDK Style Guidelines v6.What does this check flag?
<code>...</code> -> {@code ...}<a href="#..."> (internal links) -> {@link ...}< -> {@literal <}> -> {@literal >}What is NOT flagged (skipped)?
<p>,<pre>,<ul>,<li>,<table>, etc.<a href="https://..."><pre>blocks{@code}and{@literal}inline tagsNew module config: https://gist.githubusercontent.com/vivek-0509/7405297ffbf34d9007e52d45d7e9ff67/raw/589e62c2a2e5e670b45d538272f04faacc7b36f2/preferjavadocinlineTags.xml
Contirbution repo PR: checkstyle/contribution#1030