Module `Errors.Tools_error`Source

Errors raised by Tools

Sourcetype handle_subs_error = [

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

]

Sourcetype reference_kind = [

| `S
| `T
| `C
| `CT
| `Page
| `Cons
| `Field
| `Label
| `Page_path
| `Module_path
| `Asset_path
| `Any_path

]

Sourcetype path_kind = [

| `Page
| `Unit

]

Sourcetype expansion_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 ]
| `UnresolvedOriginalPath of Cpath.module_ * simple_module_lookup_error

]

Sourceand simple_module_lookup_error = [

| `Local of Env.t * Ident.module_
| `Find_failure
| `Lookup_failure of Odoc_model.Paths.Identifier.Path.Module.t
| `Lookup_failure_root of Odoc_model.Names.ModuleName.t
| `Parent of parent_lookup_error

]

Sourceand 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

]

Sourceand 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

]

Sourceand simple_type_lookup_error = [

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

]

Sourceand simple_value_lookup_error = [

| `LocalValue of Env.t * Ident.value
| `Find_failure
| `Lookup_failureV of Odoc_model.Paths.Identifier.Path.Value.t
| `Parent of parent_lookup_error

]

Sourceand parent_lookup_error = [

| `Parent_sig of expansion_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

]

Sourceand 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
| `Path_error of [ `Not_found | `Is_directory | `Wrong_kind of path_kind list * path_kind ] * Odoc_model.Paths.Reference.tag_hierarchy * string list
| `Parent of parent_lookup_error

]

Sourcetype any = [

| simple_type_lookup_error
| simple_value_lookup_error
| simple_module_type_lookup_error
| simple_module_type_expr_of_module_error
| simple_module_lookup_error
| expansion_of_module_error
| parent_lookup_error

]

Source

val 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

Source

val pp_human_list : 
  (Format.formatter -> 'a -> unit) ->
  Format.formatter ->
  'a list ->
  unit

Source

val pp_path : 
  Format.formatter ->
  ([< `TAbsolutePath | `TCurrentPackage | `TRelativePath ] * string list) ->
  unit

Sourceval pp_path_kind : Format.formatter -> [< `Page | `Unit ] -> unit

Source

val 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

Source

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

Install

Dune Dependency

Authors

Maintainers

Sources

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

Module `Errors.Tools_error`Source

package odoc

Install

Dune Dependency

Authors

Maintainers

Sources

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

Module Errors.Tools_errorSource

Module `Errors.Tools_error`Source