module Check:sig
..end
type
file =
| |
Interface |
(* |
The analyzed file is an interface.
| *) |
| |
Implementation |
(* |
The analyzed file is an implementation.
| *) |
typereport_function =
int -> int option -> string -> unit
type
report = {
|
filename : |
(* |
Name of file being analyzed.
| *) |
|
info : |
(* |
Function used to report an information.
| *) |
|
warning : |
(* |
Function used to report a warning.
| *) |
|
error : |
(* |
Function used to report an error.
| *) |
module type T =sig
..end
typelines =
file * (int * string) list
typeocamldoc =
Odoc_info.Module.t_module
typetokens =
file * (int * int * Camlp4.Sig.camlp4_token) list
typestructure =
Camlp4.PreCast.Ast.str_item
typesignature =
Camlp4.PreCast.Ast.sig_item
typeannotations =
Annotation.file
typebinary_annotations =
Cmt_format.cmt_infos
module type Lines =T
with type t = lines
module type OCamldoc =T
with type t = ocamldoc
module type Tokens =T
with type t = tokens
module type Structure =T
with type t = structure
module type Signature =T
with type t = signature
module type Annotations =T
with type t = annotations
module type Binary_annotations =T
with type t = binary_annotations
type
t =
| |
Lines of |
(* |
Checks over source lines.
| *) |
| |
OCamldoc of |
(* |
Checks over ocamldoc comments.
| *) |
| |
Tokens of |
(* |
Checks over source tokens.
| *) |
| |
Structure of |
(* |
Checks over implementation syntax trees.
| *) |
| |
Signature of |
(* |
Checks over interface syntax trees.
| *) |
| |
Annotations of |
(* |
Checks over annotation files.
| *) |
| |
Binary_annotations of |
(* |
Checks over binary annotation files.
| *) |
val category : t -> CategoryName.t
val name : t -> CheckName.t
val multiple : t -> bool
val description : t -> string
val documentation : t -> string
val rationale : t -> string
val limits : t -> string
val parameters : t -> Parameter.map
val same : t -> t -> bool