package dolmen_loop

You can search for identifiers within the package.

in-package search v0.2.0

Package contains no libraries

type 'a t = 'a warning

The type of warnings, parameterized by their payload/parameters.

val code : _ t -> Code.t

Return the return code of an error.

val name : _ t -> string

Return the name (short description) of a warning.

val mnemonic : _ t -> string

Return the mnemonic of a warning.

val print : Format.formatter -> ('a t * 'a) -> unit

Print a warning.

val print_hints : Format.formatter -> ('a t * 'a) -> unit

Print an warning's hints.

val print_doc : Format.formatter -> _ t -> unit

Print the (long) documentation of a warning.

val mk : 
  ?code:Code.t ->
  mnemonic:string ->
  message:(Format.formatter -> 'a -> unit) ->
  ?hints:('a -> (Format.formatter -> unit) option) list ->
  name:string ->
  ?doc:(Format.formatter -> unit) ->
  unit ->
  'a t

Create a new warning.

module Status : sig ... end