package odoc

You can search for identifiers within the package.

in-package search v0.2.0

OCaml Documentation Generator

Install

dune-project

Dependency

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

Authors

Maintainers

Sources

odoc-3.2.1.tbz

sha256=d45eb125514839fd9ac27702bb4938d1b4f3b6978e9b16ab9673ea067245affc

sha512=3555386b4770a7caa8ec903683bde5ecdc41d5e57ffaee617d5da225c747bbd1e9c1d2677f4df97e96bbdfc69f580ea83b1b92b933ea40a436a658788b677bbc

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.

Source

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 ().