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

sha256=f574dbd28cd0fc3a2b95525c4bb95ddf6d1f6408bb4fe12157fa537884f987fd

sha512=1c545c281a7022a167f028fff8cec6fb3f2f82da0881431be74e7a4281c5353ed83bfbdb4d9d9e08af6755dbe3505c052c5e5b58cdeb08c57aed5e89c0f15e91

doc/odoc.xref2/Odoc_xref2/Errors/Tools_error/index.html

Module `Errors.Tools_error`

Errors raised by Tools

type handle_subs_error = [

| `UnresolvedPath of [ `Module of Cpath.module_ ]

]

type reference_kind = [

| `S
| `T
| `C
| `CT
| `Page
| `Cons
| `Field
| `Label

]

type signature_of_module_error = [

| `OpaqueModule
| `UnresolvedForwardPath
| `UnresolvedPath of [ `Module of Cpath.module_ * simple_module_lookup_error | `ModuleType of Cpath.module_type * simple_module_type_lookup_error ]
| `UnexpandedTypeOf of Component.ModuleType.type_of_desc

]

and simple_module_lookup_error = [

| `Local of Env.t * Ident.path_module
| `Unresolved_apply
| `Find_failure
| `Lookup_failure of Odoc_model.Paths.Identifier.Path.Module.t
| `Lookup_failure_root of string
| `Parent of parent_lookup_error

]

and simple_module_type_expr_of_module_error = [

| `ApplyNotFunctor
| `OpaqueModule
| `UnresolvedForwardPath
| `UnresolvedPath of [ `Module of Cpath.module_ * simple_module_lookup_error | `ModuleType of Cpath.module_type * simple_module_type_lookup_error ]
| `Parent of parent_lookup_error

]

and simple_module_type_lookup_error = [

| `LocalMT of Env.t * Ident.module_type
| `Find_failure
| `Lookup_failureMT of Odoc_model.Paths.Identifier.ModuleType.t
| `Parent of parent_lookup_error

]

and simple_type_lookup_error = [

| `LocalType of Env.t * Ident.path_type
| `Class_replaced
| `OpaqueClass
| `Find_failure
| `Lookup_failureT of Odoc_model.Paths.Identifier.Path.Type.t
| `Parent of parent_lookup_error

]

and parent_lookup_error = [

| `Parent_sig of signature_of_module_error
| `Parent_module_type of simple_module_type_lookup_error
| `Parent_expr of simple_module_type_expr_of_module_error
| `Parent_module of simple_module_lookup_error
| `Parent_type of simple_type_lookup_error
| `Fragment_root
| `Parent of parent_lookup_error
| `Reference of reference_lookup_error

]

and reference_lookup_error = [

| `Wrong_kind of reference_kind list * reference_kind
| `Lookup_by_name of [ reference_kind | `Any ] * string
| `Find_by_name of [ reference_kind | `Any ] * string
| `Parent of parent_lookup_error

]

type any = [

| simple_type_lookup_error
| simple_module_type_lookup_error
| simple_module_type_expr_of_module_error
| simple_module_lookup_error
| signature_of_module_error
| parent_lookup_error

]

val pp_reference_kind : 
  Format.formatter ->
  [< `C | `CT | `Cons | `Field | `Label | `Page | `S | `T ] ->
  unit

val pp : Format.formatter -> any -> unit

val pp_reference_lookup_error : 
  Format.formatter ->
  reference_lookup_error ->
  unit