Pull #19880: resolve Qodana inspections in Javadoc and test utilities#19880
Conversation
f067b8e to
4f9021c
Compare
| - src/test/java/com/puppycrawl/tools/checkstyle/checks/javadoc/ParseTreeBuilder.java | ||
| - src/test/java/com/puppycrawl/tools/checkstyle/grammar/javadoc/ParseTreeBuilder.java | ||
| - src/main/java/com/puppycrawl/tools/checkstyle/api/JavadocCommentsTokenTypes.java | ||
| - src/main/java/com/puppycrawl/tools/checkstyle/api/JavadocCommentsTokenTypes.java |
There was a problem hiding this comment.
We try to keep there permanent suppression.
If any temporary suppression requires, we can create issue to fix they, list them in description of issue and put above suppression comment "untill xxxxx" to make it clear it is temporary
7b6da50 to
f20fb6d
Compare
|
Github, generate website |
|
This PR became not that minor. On next push, please put prefix "Pull #19880" to commit |
|
Github, generate website |
|
Solved all the issue related to Qodana. Please review it. |
|
InheritDoc looks bad 
:( not good. But it might be caused by javadoc to xdoc translation logic that we own. |
|
Well i was thinking that javadoc might not generate the |
| * {@code Modifier#MANDATED} as a hexadecimal value, padded with zeros to a width of four characters.</p> | ||
| * <pre>{@code | ||
| * {@value %04x Modifier#MANDATED} | ||
| * String.format("0x%04x", Modifier.MANDATED) |
There was a problem hiding this comment.
If we need to change it, we have to regenerate AST that it printed below
There was a problem hiding this comment.
Here is the new AST :
COMPILATION_UNIT -> COMPILATION_UNIT [1:1]
`--CLASS_DEF -> CLASS_DEF [1:1]
|--MODIFIERS -> MODIFIERS [1:1]
| `--LITERAL_PUBLIC -> public [1:1]
|--LITERAL_CLASS -> class [1:8]
|--IDENT -> Test [1:14]
`--OBJBLOCK -> OBJBLOCK [1:19]
|--LCURLY -> { [1:19]
|--VARIABLE_DEF -> VARIABLE_DEF [7:5]
| |--MODIFIERS -> MODIFIERS [7:5]
| | |--BLOCK_COMMENT_BEGIN -> /* [4:5]
| | | |--COMMENT_CONTENT -> *\n * {@value %04x java.lang.reflect.Modifier#PUBLIC}\n [4:7]
| | | | `--JAVADOC_CONTENT -> JAVADOC_CONTENT [4:8]
| | | | |--NEWLINE -> \n [4:8]
| | | | |--LEADING_ASTERISK -> * [5:1]
| | | | |--TEXT -> [5:7]
| | | | |--JAVADOC_INLINE_TAG -> JAVADOC_INLINE_TAG [5:8]
| | | | | `--VALUE_INLINE_TAG -> VALUE_INLINE_TAG [5:8]
| | | | | |--JAVADOC_INLINE_TAG_START -> {@ [5:8]
| | | | | |--TAG_NAME -> value [5:10]
| | | | | |--TEXT -> [5:15]
| | | | | |--FORMAT_SPECIFIER -> %04x [5:16]
| | | | | |--TEXT -> [5:20]
| | | | | |--REFERENCE -> REFERENCE [5:21]
| | | | | | |--IDENTIFIER -> java.lang.reflect.Modifier [5:21]
| | | | | | |--HASH -> # [5:47]
| | | | | | `--MEMBER_REFERENCE -> MEMBER_REFERENCE [5:48]
| | | | | | `--IDENTIFIER -> PUBLIC [5:48]
| | | | | `--JAVADOC_INLINE_TAG_END -> } [5:54]
| | | | |--NEWLINE -> \n [5:55]
| | | | `--TEXT -> [6:1]
| | | `--BLOCK_COMMENT_END -> */ [6:6]
| | |--LITERAL_PUBLIC -> public [7:5]
| | |--LITERAL_STATIC -> static [7:12]
| | `--FINAL -> final [7:19]
| |--TYPE -> TYPE [7:25]
| | `--LITERAL_INT -> int [7:25]
| |--IDENT -> FORMAT_SPECIFIER [7:29]
| |--ASSIGN -> = [7:46]
| | `--EXPR -> EXPR [7:48]
| | `--NUM_INT -> 36 [7:48]
| `--SEMI -> ; [7:50]
`--RCURLY -> } [8:1]
Updated the tree.
just checking qodana issue.
Found it at : https://github.com/checkstyle/checkstyle/actions/runs/26018067431/job/76472630622?pr=19816
https://www.jetbrains.com/help/inspectopedia/ReplaceAllNonRegex.html#locating-this-inspection