Issue #13627: Use violation messages macro in header templates

checkstyle · Aug 26, 2023 · 0dba32b · 0dba32b
1 parent 148cddd
commit 0dba32b
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 24 deletions.
diff --git a/src/xdocs/checks/header/header.xml b/src/xdocs/checks/header/header.xml
@@ -168,11 +168,13 @@ line 5: ////////////////////////////////////////////////////////////////////
         <ul>
           <li>
             <a href="https://github.com/search?q=path%3Asrc%2Fmain%2Fresources%2Fcom%2Fpuppycrawl%2Ftools%2Fcheckstyle%2Fchecks%2Fheader%20path%3A**%2Fmessages*.properties+repo%3Acheckstyle%2Fcheckstyle+%22header.mismatch%22">
-            header.mismatch</a>
+              header.mismatch
+            </a>
           </li>
           <li>
             <a href="https://github.com/search?q=path%3Asrc%2Fmain%2Fresources%2Fcom%2Fpuppycrawl%2Ftools%2Fcheckstyle%2Fchecks%2Fheader%20path%3A**%2Fmessages*.properties+repo%3Acheckstyle%2Fcheckstyle+%22header.missing%22">
-            header.missing</a>
+              header.missing
+            </a>
           </li>
         </ul>
         <p>

diff --git a/src/xdocs/checks/header/header.xml.template b/src/xdocs/checks/header/header.xml.template
@@ -159,16 +159,9 @@ line 5: ////////////////////////////////////////////////////////////////////
       </subsection>
 
       <subsection name="Violation Messages" id="Violation_Messages">
-        <ul>
-          <li>
-            <a href="https://github.com/search?q=path%3Asrc%2Fmain%2Fresources%2Fcom%2Fpuppycrawl%2Ftools%2Fcheckstyle%2Fchecks%2Fheader%20path%3A**%2Fmessages*.properties+repo%3Acheckstyle%2Fcheckstyle+%22header.mismatch%22">
-            header.mismatch</a>
-          </li>
-          <li>
-            <a href="https://github.com/search?q=path%3Asrc%2Fmain%2Fresources%2Fcom%2Fpuppycrawl%2Ftools%2Fcheckstyle%2Fchecks%2Fheader%20path%3A**%2Fmessages*.properties+repo%3Acheckstyle%2Fcheckstyle+%22header.missing%22">
-            header.missing</a>
-          </li>
-        </ul>
+        <macro name="violation-messages">
+          <param name="checkName" value="Header"/>
+        </macro>
         <p>
           All messages can be customized if the default message doesn't suit you.
           Please <a href="../../config.html#Custom_messages">see the documentation</a>

diff --git a/src/xdocs/checks/header/regexpheader.xml b/src/xdocs/checks/header/regexpheader.xml
@@ -242,11 +242,13 @@ public class ThisWillPass { }
         <ul>
           <li>
             <a href="https://github.com/search?q=path%3Asrc%2Fmain%2Fresources%2Fcom%2Fpuppycrawl%2Ftools%2Fcheckstyle%2Fchecks%2Fheader%20path%3A**%2Fmessages*.properties+repo%3Acheckstyle%2Fcheckstyle+%22header.mismatch%22">
-            header.mismatch</a>
+              header.mismatch
+            </a>
           </li>
           <li>
             <a href="https://github.com/search?q=path%3Asrc%2Fmain%2Fresources%2Fcom%2Fpuppycrawl%2Ftools%2Fcheckstyle%2Fchecks%2Fheader%20path%3A**%2Fmessages*.properties+repo%3Acheckstyle%2Fcheckstyle+%22header.missing%22">
-            header.missing</a>
+              header.missing
+            </a>
           </li>
         </ul>
         <p>

diff --git a/src/xdocs/checks/header/regexpheader.xml.template b/src/xdocs/checks/header/regexpheader.xml.template
@@ -229,16 +229,9 @@ line 6: ^\W*$
       </subsection>
 
       <subsection name="Violation Messages" id="Violation_Messages">
-        <ul>
-          <li>
-            <a href="https://github.com/search?q=path%3Asrc%2Fmain%2Fresources%2Fcom%2Fpuppycrawl%2Ftools%2Fcheckstyle%2Fchecks%2Fheader%20path%3A**%2Fmessages*.properties+repo%3Acheckstyle%2Fcheckstyle+%22header.mismatch%22">
-            header.mismatch</a>
-          </li>
-          <li>
-            <a href="https://github.com/search?q=path%3Asrc%2Fmain%2Fresources%2Fcom%2Fpuppycrawl%2Ftools%2Fcheckstyle%2Fchecks%2Fheader%20path%3A**%2Fmessages*.properties+repo%3Acheckstyle%2Fcheckstyle+%22header.missing%22">
-            header.missing</a>
-          </li>
-        </ul>
+        <macro name="violation-messages">
+          <param name="checkName" value="RegexpHeader"/>
+        </macro>
         <p>
           All messages can be customized if the default message doesn't suit you.
           Please <a href="../../config.html#Custom_messages">see the documentation</a>