class Finding

Defined at line 44 of file ../../tools/fidl/fidlc/src/findings.h

Public Methods

void Finding (SourceSpan span, std::string subcategory, std::string message)

Construct a Finding with an analyzer-specific subcategory string (for

example, fidl-lint's check-id), SourceSpan, and message

Defined at line 48 of file ../../tools/fidl/fidlc/src/findings.h

void Finding (Finding && rhs)

move constructor

Defined at line 52 of file ../../tools/fidl/fidlc/src/findings.h

template <typename... Args>

Suggestion & SetSuggestion (Args &&... args)

Construct a new Suggestion with its constructor arguments, and add it to

the Finding.

Defined at line 57 of file ../../tools/fidl/fidlc/src/findings.h

const SourceSpan & span ()

Returns a reference to a portion of a |SourceFile|, with supporting

methods to get the relative location of the reference within the file

(line and column), and std::string_view (substring) representing the characters

from reference start to end.

Defined at line 66 of file ../../tools/fidl/fidlc/src/findings.h

const std::string & subcategory ()

Subcategory of the result (for example, fidl-lint's check-id). Used

to construct a Comment category, as described in the Tricium protobuf:

Category of the result, encoded as a path with the analyzer name as the

root, followed by an arbitrary number of subcategories, for example

"ClangTidy/llvm-header-guard".

https://chromium.googlesource.com/infra/infra/+/HEAD/go/src/infra/tricium/api/v1/data.proto

Defined at line 76 of file ../../tools/fidl/fidlc/src/findings.h

const std::string & message ()

The annotation, as a human consumable text string.

Defined at line 79 of file ../../tools/fidl/fidlc/src/findings.h

const std::optional<Suggestion> & suggestion ()

An optional |Suggestion| to correct the issue (potentially with

a suggested |Replacement|).

Defined at line 83 of file ../../tools/fidl/fidlc/src/findings.h