Skip to content

Commit 32692d7

Browse files
Convert getHelp() methods to HTML format
- Changed plain text with \n to proper HTML with <p> and <code> tags - Follows the same pattern as EclipseDescriptor and PnpmAuditDescriptor - HTML formatting allows proper display in the UI with preserved formatting - Regenerated SUPPORTED-FORMATS.md with HTML help text - All tests pass (1321 tests, 0 failures)
1 parent a11fb77 commit 32692d7

File tree

3 files changed

+22
-12
lines changed

3 files changed

+22
-12
lines changed

SUPPORTED-FORMATS.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!--- DO NOT EDIT -- Generated at 2025-11-05T15:24:45.809034732 - Run the `main` method of `ParserRegistry` to regenerate after changing parsers -- DO NOT EDIT --->
1+
<!--- DO NOT EDIT -- Generated at 2025-11-06T03:09:23.486509300 - Run the `main` method of `ParserRegistry` to regenerate after changing parsers -- DO NOT EDIT --->
22
# Supported Report Formats
33

44
The static analysis model supports the following report formats.
@@ -956,12 +956,17 @@ If your tool is supported, but some properties are missing (icon, URL, etc.), pl
956956
-
957957
</td>
958958
<td>
959-
GNU C Compiler (gcc)
959+
GNU C Compiler (GCC)
960960
</td>
961961
<td>
962962
-
963963
</td>
964964
</tr>
965+
<tr>
966+
<td colspan="4">
967+
:bulb: <p>Parses warnings and errors generated by GCC version 4 and newer (including GCC 5–15+). Use this parser for modern GCC compilers that output messages in the standard format like:</p><p><code>file.c:10:5: warning: unused variable 'x' [-Wunused-variable]</code></p><p>For very old GCC versions (pre-GCC 4), use the 'gcc3' parser instead.</p>
968+
</td>
969+
</tr>
965970
<tr>
966971
<td>
967972
gcc3
@@ -970,12 +975,17 @@ If your tool is supported, but some properties are missing (icon, URL, etc.), pl
970975
-
971976
</td>
972977
<td>
973-
GNU C Compiler 3 (gcc)
978+
GNU C Compiler (Legacy, pre-GCC 4)
974979
</td>
975980
<td>
976981
-
977982
</td>
978983
</tr>
984+
<tr>
985+
<td colspan="4">
986+
:bulb: <p>Parses warnings and errors from legacy GCC compilers (versions older than GCC 4). This parser uses an older, simpler warning format.</p><p>For modern GCC versions (GCC 4 and newer, including GCC 5–15), use the 'gcc' parser instead, which supports the newer format with additional context like:</p><p><code>file.c:10:5: warning: unused variable 'x' [-Wunused-variable]</code></p>
987+
</td>
988+
</tr>
979989
<tr>
980990
<td>
981991
fortran

src/main/java/edu/hm/hafner/analysis/registry/Gcc4Descriptor.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,10 @@ protected Collection<? extends IssueParser> createParsers() {
3636

3737
@Override
3838
public String getHelp() {
39-
return "Parses warnings and errors generated by GCC version 4 and newer "
39+
return "<p>Parses warnings and errors generated by GCC version 4 and newer "
4040
+ "(including GCC 5–15+). Use this parser for modern GCC compilers "
41-
+ "that output messages in the standard format like:\n"
42-
+ "file.c:10:5: warning: unused variable 'x' [-Wunused-variable]\n\n"
43-
+ "For very old GCC versions (pre-GCC 4), use the 'gcc3' parser instead.";
41+
+ "that output messages in the standard format like:</p>"
42+
+ "<p><code>file.c:10:5: warning: unused variable 'x' [-Wunused-variable]</code></p>"
43+
+ "<p>For very old GCC versions (pre-GCC 4), use the 'gcc3' parser instead.</p>";
4444
}
4545
}

src/main/java/edu/hm/hafner/analysis/registry/GccDescriptor.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,10 @@ public IssueParser create(final Option... options) {
2828

2929
@Override
3030
public String getHelp() {
31-
return "Parses warnings and errors from legacy GCC compilers (versions older than GCC 4). "
32-
+ "This parser uses an older, simpler warning format.\n\n"
33-
+ "For modern GCC versions (GCC 4 and newer, including GCC 5–15), use the 'gcc' parser instead, "
34-
+ "which supports the newer format with additional context like:\n"
35-
+ "file.c:10:5: warning: unused variable 'x' [-Wunused-variable]";
31+
return "<p>Parses warnings and errors from legacy GCC compilers (versions older than GCC 4). "
32+
+ "This parser uses an older, simpler warning format.</p>"
33+
+ "<p>For modern GCC versions (GCC 4 and newer, including GCC 5–15), use the 'gcc' parser instead, "
34+
+ "which supports the newer format with additional context like:</p>"
35+
+ "<p><code>file.c:10:5: warning: unused variable 'x' [-Wunused-variable]</code></p>";
3636
}
3737
}

0 commit comments

Comments
 (0)