package odoc

  1. Overview
  2. Docs
OCaml Documentation Generator

Install 

dune-project
 Dependency

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

Authors

  1. Anton Bachin
  2. Daniel Bünzli
  3. D
    David Sheets <sheets@alum.mit.edu>
  4. J
    Jon Ludlam <jon@recoil.org>
  5. J
    Jules Aguillon <juloo.dsi@gmail.com>
  6. L
    Leo White <leo@lpw25.net>
  7. L
    Lubega Simon <lubegasimon73@gmail.com>
  8. P
    Paul-Elliot Anglès d'Auriac <paul-elliot@tarides.com>
  9. T
    Thomas Refis <trefis@janestreet.com>

Maintainers

  1. Daniel Bünzli
  2. J
    Jon Ludlam <jon@recoil.org>
  3. J
    Jules Aguillon <juloo.dsi@gmail.com>
  4. P
    Paul-Elliot Anglès d'Auriac <paul-elliot@tarides.com>

Sources

odoc-3.1.0.tbz
sha256=355b3cfff4934903cbaed8b51ce35e333e8609932d230294200a9f2d42ffa914
sha512=f78318d0a16164a9cd16ee02f611c2e00d32b772fe38e992d6db6ec94b1c00cd9c377fbfe64031b8f245e57b2f3aac9364108327e7f1693533ddcff94c476e05

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

Module Errors.Tools_errorSource

Errors raised by Tools

Sourcetype handle_subs_error = [
  1. | `UnresolvedPath of [ `Module of Cpath.module_ ]
]
Sourcetype reference_kind = [
  1. | `S
  2. | `T
  3. | `C
  4. | `CT
  5. | `Page
  6. | `Cons
  7. | `Field
  8. | `Label
  9. | `Page_path
  10. | `Module_path
  11. | `Asset_path
  12. | `Any_path
]
Sourcetype path_kind = [
  1. | `Page
  2. | `Unit
]
Sourcetype expansion_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. | `UnresolvedOriginalPath of Cpath.module_ * simple_module_lookup_error
]
Sourceand simple_module_lookup_error = [
  1. | `Local of Env.t * Ident.module_
  2. | `Find_failure
  3. | `Lookup_failure of Odoc_model.Paths.Identifier.Path.Module.t
  4. | `Lookup_failure_root of Odoc_model.Names.ModuleName.t
  5. | `Parent of parent_lookup_error
]
Sourceand 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
]
Sourceand 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
]
Sourceand simple_type_lookup_error = [
  1. | `LocalType of Env.t * Ident.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
]
Sourceand simple_value_lookup_error = [
  1. | `LocalValue of Env.t * Ident.value
  2. | `Find_failure
  3. | `Lookup_failureV of Odoc_model.Paths.Identifier.Path.Value.t
  4. | `Parent of parent_lookup_error
]
Sourceand parent_lookup_error = [
  1. | `Parent_sig of expansion_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
]
Sourceand 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. | `Path_error of [ `Not_found | `Is_directory | `Wrong_kind of path_kind list * path_kind ] * Odoc_model.Paths.Reference.tag_hierarchy * string list
  5. | `Parent of parent_lookup_error
]
Sourceval pp_reference_kind : Format.formatter -> [< `Any_path | `Asset_path | `C | `CT | `Cons | `Field | `Label | `Module_path | `Page | `Page_path | `S | `T ] -> unit
Sourceval fpf : Format.formatter -> ('a, Format.formatter, unit) format -> 'a
Sourceval pp_human_list : (Format.formatter -> 'a -> unit) -> Format.formatter -> 'a list -> unit
Sourceval pp_path : Format.formatter -> ([< `TAbsolutePath | `TCurrentPackage | `TRelativePath ] * string list) -> unit
Sourceval pp_path_kind : Format.formatter -> [< `Page | `Unit ] -> unit
Sourceval pp_path_error : Format.formatter -> [< `Is_directory | `Not_found | `Wrong_kind of [< `Page | `Unit ] list * [< `Page | `Unit ] ] -> [< `TAbsolutePath | `TCurrentPackage | `TRelativePath ] -> string list -> unit
Sourceval pp : Format.formatter -> any -> unit
Sourceval pp_reference_lookup_error : Format.formatter -> reference_lookup_error -> unit