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 Edit opam file Versions (3)

Authors

Maintainers

Sources

odoc-3.0.0.tbz

sha256=ce84fa7e0cc5f3e8a54e6adeb10826152798b602057b9e46c5ae7e5d5206812b

sha512=9febd413450ca2e3824c9ef7e1c9ae8d8094aa72ed71327a69d8d6b42f6f197b3f3f40d674de0d11fa1242ee0df95c693b5d74467d530704e1339f3a523452f6

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

Module `Odoc_xref2.Lookup_failures`Source

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.

Source

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.

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

Internal errors happens during compiling and linking.

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

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

Warnings are user errors.

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

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