package odoc
OCaml documentation generator
Install
Dune Dependency
Authors
Maintainers
Sources
odoc-2.1.1.tbz
sha256=f574dbd28cd0fc3a2b95525c4bb95ddf6d1f6408bb4fe12157fa537884f987fd
sha512=1c545c281a7022a167f028fff8cec6fb3f2f82da0881431be74e7a4281c5353ed83bfbdb4d9d9e08af6755dbe3505c052c5e5b58cdeb08c57aed5e89c0f15e91
doc/odoc.model/Odoc_model/Error/index.html
Module Odoc_model.Error
val make :
?suggestion:string ->
('a, Format.formatter, unit, Location_.span -> t) format4 ->
'a
val filename_only :
?suggestion:string ->
('a, Format.formatter, unit, string -> t) format4 ->
'a
val to_string : t -> string
val raise_exception : t -> _
Raise a t
as an exception. Can be caught with catch
or catch_errors_and_warnings
.
val catch : (unit -> 'a) -> ('a, t) Result.result
val raise_warning : ?non_fatal:bool -> t -> unit
Raise a warning that need to be caught with catch_warnings
. non_fatal
is false
by default.
val raise_warnings : 'a with_warnings -> 'a
Accumulate warnings into a global variable. See catch_warnings
.
val catch_warnings : (unit -> 'a) -> 'a with_warnings
Catch warnings accumulated by raise_warning
. Safe to nest.
type 'a with_errors_and_warnings = ('a, t) Result.result with_warnings
Subtype of with_warnings
.
val raise_errors_and_warnings : 'a with_errors_and_warnings -> 'a
val catch_errors_and_warnings : (unit -> 'a) -> 'a with_errors_and_warnings
Combination of catch
and catch_warnings
.
val handle_warnings :
warnings_options:warnings_options ->
'a with_warnings ->
('a, [> `Msg of string ]) Result.result
Print warnings to stderr. If warn_error
is true
and there was warnings, returns an Error
.
val handle_errors_and_warnings :
warnings_options:warnings_options ->
'a with_errors_and_warnings ->
('a, [> `Msg of string ]) Result.result
Like handle_warnings
but works on the output of catch_errors_and_warnings
. Error case is converted into a `Msg
.
val print_errors : t list -> unit
Used internally by handle_warnings
.
val unpack_warnings : 'a with_warnings -> 'a * t list
val t_of_parser_t : Odoc_parser.Warning.t -> t
Convert a parsing error into a t
.
val raise_parser_warnings : Odoc_parser.t -> Odoc_parser.Ast.t
Like raise_warnings
but handle parsing errors.
sectionYPositions = computeSectionYPositions($el), 10)"
x-init="setTimeout(() => sectionYPositions = computeSectionYPositions($el), 10)"
>