package odoc

You can search for identifiers within the package.

in-package search v0.2.0

OCaml documentation generator

Install

Dune Dependency

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

Authors

Maintainers

J

Jon Ludlam <jon@recoil.org>

Sources

odoc-2.1.1.tbz

sha256=f574dbd28cd0fc3a2b95525c4bb95ddf6d1f6408bb4fe12157fa537884f987fd

sha512=1c545c281a7022a167f028fff8cec6fb3f2f82da0881431be74e7a4281c5353ed83bfbdb4d9d9e08af6755dbe3505c052c5e5b58cdeb08c57aed5e89c0f15e91

doc/odoc.xref2/Odoc_xref2/Lookup_failures/index.html

Module `Odoc_xref2.Lookup_failures`

Report non-fatal errors.

The main difference with Odoc_model.Error is that no precise location is attached to each failures, instead a filename is given to catch_failures.

val catch_failures : 
  filename:string ->
  (unit -> 'a) ->
  'a Odoc_model.Error.with_warnings

Catch failures that are reported by f. filename is the initial location of generated errors, more precise locations can be specified with with_location.

val report_internal : ('fmt, Format.formatter, unit, unit) format4 -> 'fmt

Internal errors happens during compiling and linking.

val report_root : name:string -> unit

Root errors happens when a dependency couldn't be loaded. These errors won't be made fatal in "warn error" mode.

val report_warning : ('fmt, Format.formatter, unit, unit) format4 -> 'fmt

Warnings are user errors.

val with_location : Odoc_model.Location_.span -> (unit -> 'a) -> 'a

Failures reported indirectly by this function will have a location attached.

val with_context : 
  ('fmt, Format.formatter, unit, (unit -> 'a) -> 'a) format4 ->
  'fmt

with_context "format string" format_arguments f adds context to failures reported by f ().