package odoc

  1. Overview
  2. Docs
OCaml documentation generator

Install 

dune-project
 Dependency

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

Authors

  1. T
    Thomas Refis <trefis@janestreet.com>
  2. D
    David Sheets <sheets@alum.mit.edu>
  3. L
    Leo White <leo@lpw25.net>
  4. Anton Bachin
  5. J
    Jon Ludlam <jon@recoil.org>
  6. J
    Jules Aguillon <juloo.dsi@gmail.com>
  7. L
    Lubega Simon <lubegasimon73@gmail.com>

Maintainers

  1. J
    Jon Ludlam <jon@recoil.org>

Sources

odoc-2.1.1.tbz
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 = [
  1. | `UnresolvedPath of [ `Module of Cpath.module_ ]
]
type reference_kind = [
  1. | `S
  2. | `T
  3. | `C
  4. | `CT
  5. | `Page
  6. | `Cons
  7. | `Field
  8. | `Label
]
type signature_of_module_error = [
  1. | `OpaqueModule
  2. | `UnresolvedForwardPath
  3. | `UnresolvedPath of [ `Module of Cpath.module_ * simple_module_lookup_error | `ModuleType of Cpath.module_type * simple_module_type_lookup_error ]
  4. | `UnexpandedTypeOf of Component.ModuleType.type_of_desc
]
and simple_module_lookup_error = [
  1. | `Local of Env.t * Ident.path_module
  2. | `Unresolved_apply
  3. | `Find_failure
  4. | `Lookup_failure of Odoc_model.Paths.Identifier.Path.Module.t
  5. | `Lookup_failure_root of string
  6. | `Parent of parent_lookup_error
]
and simple_module_type_expr_of_module_error = [
  1. | `ApplyNotFunctor
  2. | `OpaqueModule
  3. | `UnresolvedForwardPath
  4. | `UnresolvedPath of [ `Module of Cpath.module_ * simple_module_lookup_error | `ModuleType of Cpath.module_type * simple_module_type_lookup_error ]
  5. | `Parent of parent_lookup_error
]
and simple_module_type_lookup_error = [
  1. | `LocalMT of Env.t * Ident.module_type
  2. | `Find_failure
  3. | `Lookup_failureMT of Odoc_model.Paths.Identifier.ModuleType.t
  4. | `Parent of parent_lookup_error
]
and simple_type_lookup_error = [
  1. | `LocalType of Env.t * Ident.path_type
  2. | `Class_replaced
  3. | `OpaqueClass
  4. | `Find_failure
  5. | `Lookup_failureT of Odoc_model.Paths.Identifier.Path.Type.t
  6. | `Parent of parent_lookup_error
]
and parent_lookup_error = [
  1. | `Parent_sig of signature_of_module_error
  2. | `Parent_module_type of simple_module_type_lookup_error
  3. | `Parent_expr of simple_module_type_expr_of_module_error
  4. | `Parent_module of simple_module_lookup_error
  5. | `Parent_type of simple_type_lookup_error
  6. | `Fragment_root
  7. | `Parent of parent_lookup_error
  8. | `Reference of reference_lookup_error
]
and reference_lookup_error = [
  1. | `Wrong_kind of reference_kind list * reference_kind
  2. | `Lookup_by_name of [ reference_kind | `Any ] * string
  3. | `Find_by_name of [ reference_kind | `Any ] * string
  4. | `Parent of 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