module type Signature = T
with type t = signature
The type of checks over interface syntax trees.
type
t
The type on which the check operates.
val category : CategoryName.t
Category name for check.
val name : CheckName.t
Name for check.
val multiple : bool
Whether the checks supports multiple instances.
val description : string
Short description for check.
val documentation : string
Full documentation for check.
val rationale : string
Justification for check.
val limits : string
Limits of check.
val parameters : Parameter.map
Parameters of check.
val run : State.id ->
Ocamldep.dependency list ->
t -> Parameter.map -> Check.report -> unit
run id deps x params report
actually runs the check over value x
.
id
is the identifier to retrieve the state associated with the check.
deps
are the dependencies for all analyzed files, and params
are the
parameters for the check instance. report
should be used to report
check violations.