Align documentation of reported description names by the Refaster check

This commit is contained in:
Pieter Dirk Soels
2022-09-30 12:02:42 +02:00
committed by Stephan Schroevers
parent 20d194b4d4
commit ad1c98d3eb

View File

@@ -153,8 +153,8 @@ public final class Refaster extends BugChecker implements CompilationUnitTreeMat
* checker's severity was explicitly configured.
*
* <p>The original check name (i.e. the Refaster template name) is prepended to the {@link
* Description}'s message. The replacement check name ("Refaster Template", a name which includes
* a space) is chosen such that it is guaranteed not to match any canonical bug checker name (as
* Description}'s message. The replacement check name ("Refaster Rule", a name which includes a
* space) is chosen such that it is guaranteed not to match any canonical bug checker name (as
* that could cause {@link VisitorState#reportMatch(Description)}} to override the reported
* severity).
*/