Skip to content

Commit a6d227d

Browse files
authored
Merge pull request github#11599 from igfoo/igfoo/diags
Java/Kotlin: Update the diagnostic severity documentation
2 parents 54701f5 + e6c3bce commit a6d227d

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

java/ql/lib/semmle/code/java/Diagnostics.qll

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,18 @@ class Diagnostic extends @diagnostic {
1515
string getGeneratedBy() { diagnostics(this, result, _, _, _, _, _) }
1616

1717
/**
18-
* Gets the severity of the message, on a range from 1 to 5: 1=remark,
19-
* 2=warning, 3=discretionary error, 4=error, 5=catastrophic error.
18+
* Gets the severity of the message.
19+
*
20+
* For Java, this ranges from 1 to 8:
21+
* 1=warning(low)
22+
* 2=warning(normal)
23+
* 3=warning(high)
24+
* 4=error(low) Minor extractor errors, with minimal impact on analysis
25+
* 5=error(normal) Most extractor errors, with local impact on analysis
26+
* 6=error(high) Errors from the frontend
27+
* 7=error(severe) Severe extractor errors affecting a single source file
28+
* 8=error(global) Severe extractor errors likely to affect multiple source files
29+
* For Kotlin, only the "normal" warning and error severities are used.
2030
*/
2131
int getSeverity() { diagnostics(this, _, result, _, _, _, _) }
2232

0 commit comments

Comments
 (0)