Skip to content

Commit 5e4e853

Browse files
committed
C++: Add missing QLDoc.
1 parent 4c4fc05 commit 5e4e853

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

cpp/ql/src/Diagnostics/FailedExtractions.qll

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,23 +21,30 @@ class ReportableError extends Diagnostic {
2121
}
2222
}
2323

24-
newtype TExtractionError =
24+
private newtype TExtractionError =
2525
TReportableError(ReportableError err) or
2626
TCompilationFailed(Compilation c, File f) {
2727
f = c.getAFileCompiled() and not c.normalTermination()
2828
} or
2929
// Report generic extractor errors only if we haven't seen any other error-level diagnostic
3030
TUnknownError(CompilerError err) { not exists(ReportableError e) }
3131

32+
/**
33+
* Superclass for the extraction error hierarchy.
34+
*/
3235
class ExtractionError extends TExtractionError {
3336
string toString() { none() }
3437

38+
/** Gets the error message for this error. */
3539
string getErrorMessage() { none() }
3640

41+
/** Gets the file this error occured in. */
3742
File getFile() { none() }
3843

44+
/** Gets the location this error occured in. */
3945
Location getLocation() { none() }
4046

47+
/** Gets the SARIF severity of this error. */
4148
int getSeverity() {
4249
// Unfortunately, we can't distinguish between errors and fatal errors in SARIF,
4350
// so all errors have severity 2.

0 commit comments

Comments
 (0)