Java/Kotlin: Update the diagnostic severity documentation

This commit is contained in:
Ian Lynagh
2022-12-07 17:14:51 +00:00
parent d53d275bba
commit e6c3bcec63

View File

@@ -15,8 +15,18 @@ class Diagnostic extends @diagnostic {
string getGeneratedBy() { diagnostics(this, result, _, _, _, _, _) }
/**
* Gets the severity of the message, on a range from 1 to 5: 1=remark,
* 2=warning, 3=discretionary error, 4=error, 5=catastrophic error.
* Gets the severity of the message.
*
* For Java, this ranges from 1 to 8:
* 1=warning(low)
* 2=warning(normal)
* 3=warning(high)
* 4=error(low) Minor extractor errors, with minimal impact on analysis
* 5=error(normal) Most extractor errors, with local impact on analysis
* 6=error(high) Errors from the frontend
* 7=error(severe) Severe extractor errors affecting a single source file
* 8=error(global) Severe extractor errors likely to affect multiple source files
* For Kotlin, only the "normal" warning and error severities are used.
*/
int getSeverity() { diagnostics(this, _, result, _, _, _, _) }