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.

Source

val report : 
  non_fatal:bool ->
  ('fmt, Stdlib.Format.formatter, unit, unit) Stdlib.format4 ->
  'fmt

Report a failure with explicit control over whether it's fatal.

Source

val report_internal : 
  ('fmt, Stdlib.Format.formatter, unit, unit) Stdlib.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.

Source

val report_warning : 
  ('fmt, Stdlib.Format.formatter, unit, unit) Stdlib.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, Stdlib.Format.formatter, unit, (unit -> 'a) -> 'a) Stdlib.format4 ->
  'fmt

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

Module Odoc_xref2.Lookup_failuresSource

Module `Odoc_xref2.Lookup_failures`Source