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>

Maintainers

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

Sources

odoc-1.5.3.tbz
sha256=f2b76f811658c4b52cb48ac4ffc2ec37cedd2a805111c7f8ec20f8f36b8bbf45
sha512=9e069590e0737c94813d25235b5cfe27feb5a0298a17ff9b9ee446c69827c3a0ea3b7da5d05b278639cd1f0202e0d83356707979edfaa2af73876fc000c23c4d

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

Module Odoc_model.Error

type t
val make : ?suggestion:string -> ('a, unit, string, Location_.span -> t) format4 -> 'a
val filename_only : string -> string -> t
val to_string : t -> string
val raise_exception : t -> _
val to_exception : ('a, t) Result.result -> 'a
val catch : (unit -> 'a) -> ('a, t) Result.result
type 'a with_warnings = {
  1. value : 'a;
  2. warnings : t list;
}
type warning_accumulator
val accumulate_warnings : (warning_accumulator -> 'a) -> 'a with_warnings
val warning : warning_accumulator -> t -> unit
val shed_warnings : 'a with_warnings -> 'a
val set_warn_error : bool -> unit

When set to true, shed_warnings will raise Failure if it had to print warnings.