package odoc

  1. Overview
  2. Docs
OCaml documentation generator

Install 

dune-project
 Dependency

github.com Readme Changelog ISC License Edit opam file Versions (4)

Authors

  1. T
    Thomas Refis <trefis@janestreet.com>
  2. D
    David Sheets <sheets@alum.mit.edu>
  3. L
    Leo White <leo@lpw25.net>
  4. Anton Bachin
  5. J
    Jon Ludlam <jon@recoil.org>
  6. J
    Jules Aguillon <juloo.dsi@gmail.com>
  7. L
    Lubega Simon <lubegasimon73@gmail.com>

Maintainers

  1. J
    Jon Ludlam <jon@recoil.org>

Sources

odoc-2.1.1.tbz
sha256=f574dbd28cd0fc3a2b95525c4bb95ddf6d1f6408bb4fe12157fa537884f987fd
sha512=1c545c281a7022a167f028fff8cec6fb3f2f82da0881431be74e7a4281c5353ed83bfbdb4d9d9e08af6755dbe3505c052c5e5b58cdeb08c57aed5e89c0f15e91

doc/odoc.model/Odoc_model/Error/index.html

Module Odoc_model.ErrorSource

Sourcetype t
Sourceval make : ?suggestion:string -> ('a, Format.formatter, unit, Location_.span -> t) format4 -> 'a
Sourceval filename_only : ?suggestion:string -> ('a, Format.formatter, unit, string -> t) format4 -> 'a
Sourceval to_string : t -> string
Sourceval raise_exception : t -> _

Raise a t as an exception. Can be caught with catch or catch_errors_and_warnings.

Sourceval catch : (unit -> 'a) -> ('a, t) Result.result
Sourcetype 'a with_warnings
Sourceval raise_warning : ?non_fatal:bool -> t -> unit

Raise a warning that need to be caught with catch_warnings. non_fatal is false by default.

Sourceval raise_warnings : 'a with_warnings -> 'a

Accumulate warnings into a global variable. See catch_warnings.

Sourceval catch_warnings : (unit -> 'a) -> 'a with_warnings

Catch warnings accumulated by raise_warning. Safe to nest.

Sourcetype 'a with_errors_and_warnings = ('a, t) Result.result with_warnings

Subtype of with_warnings.

Sourceval raise_errors_and_warnings : 'a with_errors_and_warnings -> 'a
Sourceval catch_errors_and_warnings : (unit -> 'a) -> 'a with_errors_and_warnings

Combination of catch and catch_warnings.

Sourcetype warnings_options = {
  1. warn_error : bool;
    (*

    If true, warnings will result in an error.

    *)
  2. print_warnings : bool;
    (*

    Whether to print warnings.

    *)
}
Sourceval 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.

Sourceval 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.

Sourceval print_errors : t list -> unit

Used internally by handle_warnings.

Sourceval unpack_warnings : 'a with_warnings -> 'a * t list
Sourceval t_of_parser_t : Odoc_parser.Warning.t -> t

Convert a parsing error into a t.

Sourceval raise_parser_warnings : Odoc_parser.t -> Odoc_parser.Ast.t

Like raise_warnings but handle parsing errors.