package odoc

  1. Overview
  2. Docs
OCaml Documentation Generator

Install 

dune-project
 Dependency

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

Authors

  1. Anton Bachin
  2. Daniel Bünzli
  3. D
    David Sheets <sheets@alum.mit.edu>
  4. J
    Jon Ludlam <jon@recoil.org>
  5. J
    Jules Aguillon <juloo.dsi@gmail.com>
  6. L
    Leo White <leo@lpw25.net>
  7. L
    Lubega Simon <lubegasimon73@gmail.com>
  8. P
    Paul-Elliot Anglès d'Auriac <paul-elliot@tarides.com>
  9. T
    Thomas Refis <trefis@janestreet.com>

Maintainers

  1. Daniel Bünzli
  2. J
    Jon Ludlam <jon@recoil.org>
  3. J
    Jules Aguillon <juloo.dsi@gmail.com>
  4. P
    Paul-Elliot Anglès d'Auriac <paul-elliot@tarides.com>

Sources

odoc-3.0.0.tbz
sha256=ce84fa7e0cc5f3e8a54e6adeb10826152798b602057b9e46c5ae7e5d5206812b
sha512=9febd413450ca2e3824c9ef7e1c9ae8d8094aa72ed71327a69d8d6b42f6f197b3f3f40d674de0d11fa1242ee0df95c693b5d74467d530704e1339f3a523452f6

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

Module Odoc_model.ErrorSource

Sourcetype t
Sourceval enable_missing_root_warning : bool ref
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.

    *)
  3. warnings_tag : string option;
    (*

    Whether to tag references to filter them later.

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