Module `Odoc_xref2.Errors`Source

Sourcemodule Tools_error : sig ... end

Sourcetype kind = [

| `OpaqueModule
| `Root of string

]

val kind_of_module_cpath : 
  ([> `Apply of 'a * 'a
   | `Dot of 'a * 'b
   | `Root of Odoc_model.Names.ModuleName.t
   | `Substituted of 'a ] as 'a) ->
  [> `Root of string ] option

Source

val kind_of_module_type_cpath : 
  ([> `DotMT of
        ([> `Apply of 'b * 'b
         | `Dot of 'b * 'c
         | `Root of Odoc_model.Names.ModuleName.t
         | `Substituted of 'b ] as 'b)
        * 'd
   | `Substituted of 'a ] as 'a) ->
  [> `Root of string ] option

Source

val kind_of_type_of_desc : 
  Odoc_xref2.Component.ModuleType.type_of_desc ->
  Odoc_xref2.Errors.kind option

Source

val kind_of_error : 
  what:
    [> `Include of Odoc_xref2.Component.Include.decl
    | `Module of
      [> `Root of 'a * Odoc_model.Names.ModuleName.t ]
        Odoc_model.Paths.Identifier.id ] ->
  [< `ApplyNotFunctor
  | `Class_replaced
  | `Find_failure
  | `Fragment_root
  | `Local of Odoc_xref2.Env.t * [< Odoc_xref2.Ident.module_ ]
  | `LocalMT of Odoc_xref2.Env.t * [< Odoc_xref2.Ident.module_type ]
  | `LocalType of Odoc_xref2.Env.t * [< Odoc_xref2.Ident.type_ ]
  | `LocalValue of Odoc_xref2.Env.t * [< Odoc_xref2.Ident.value ]
  | `Lookup_failure of
    [< Odoc_model.Paths.Identifier.Path.Module.t_pv ]
      Odoc_model.Paths.Identifier.id
  | `Lookup_failureMT of
    [< Odoc_model.Paths.Identifier.ModuleType.t_pv ]
      Odoc_model.Paths.Identifier.id
  | `Lookup_failureT of
    [< Odoc_model.Paths.Identifier.Path.Type.t_pv ]
      Odoc_model.Paths.Identifier.id
  | `Lookup_failureV of
    [< Odoc_model.Paths.Identifier.Value.t_pv ] Odoc_model.Paths.Identifier.id
  | `Lookup_failure_root of Odoc_model.Names.ModuleName.t
  | `OpaqueClass
  | `OpaqueModule
  | `Parent of [< Odoc_xref2.Errors.Tools_error.parent_lookup_error ]
  | `Parent_expr of
    [< `ApplyNotFunctor
    | `OpaqueModule
    | `Parent of Odoc_xref2.Errors.Tools_error.parent_lookup_error
    | `UnresolvedForwardPath
    | `UnresolvedPath of
      [ `Module of
          Odoc_xref2.Cpath.module_
          * Odoc_xref2.Errors.Tools_error.simple_module_lookup_error
      | `ModuleType of
        Odoc_xref2.Cpath.module_type
        * Odoc_xref2.Errors.Tools_error.simple_module_type_lookup_error ] ]
  | `Parent_module of
    [< Odoc_xref2.Errors.Tools_error.simple_module_lookup_error ]
  | `Parent_module_type of
    [< Odoc_xref2.Errors.Tools_error.simple_module_type_lookup_error ]
  | `Parent_sig of
    [< `OpaqueModule
    | `UnresolvedForwardPath
    | `UnresolvedOriginalPath of
      Odoc_xref2.Cpath.module_
      * Odoc_xref2.Errors.Tools_error.simple_module_lookup_error
    | `UnresolvedPath of
      [ `Module of
          Odoc_xref2.Cpath.module_
          * Odoc_xref2.Errors.Tools_error.simple_module_lookup_error
      | `ModuleType of
        Odoc_xref2.Cpath.module_type
        * Odoc_xref2.Errors.Tools_error.simple_module_type_lookup_error ] ]
  | `Parent_type of [< Odoc_xref2.Errors.Tools_error.simple_type_lookup_error ]
  | `Reference of
    [< `Find_by_name of
         [< `Any
         | `Any_path
         | `Asset_path
         | `C
         | `CT
         | `Cons
         | `Field
         | `Label
         | `Module_path
         | `Page
         | `Page_path
         | `S
         | `T
         | `UnboxedField ]
         * string
    | `Lookup_by_name of
      [< `Any
      | `Any_path
      | `Asset_path
      | `C
      | `CT
      | `Cons
      | `Field
      | `Label
      | `Module_path
      | `Page
      | `Page_path
      | `S
      | `T
      | `UnboxedField ]
      * string
    | `Parent of Odoc_xref2.Errors.Tools_error.parent_lookup_error
    | `Path_error of
      [< `Is_directory
      | `Not_found
      | `Wrong_kind of
        Odoc_xref2.Errors.Tools_error.path_kind list
        * Odoc_xref2.Errors.Tools_error.path_kind Wrong_kind ]
      * Odoc_model.Paths.Reference.tag_hierarchy
      * string list
    | `Wrong_kind of
      Odoc_xref2.Errors.Tools_error.reference_kind list
      * Odoc_xref2.Errors.Tools_error.reference_kind ]
  | `UnresolvedForwardPath
  | `UnresolvedOriginalPath of
    [< Odoc_xref2.Cpath.module_ ]
    * [< Odoc_xref2.Errors.Tools_error.simple_module_lookup_error ]
  | `UnresolvedPath of
    [< `Module of
         [< Odoc_xref2.Cpath.module_ ]
         * [< Odoc_xref2.Errors.Tools_error.simple_module_lookup_error ]
    | `ModuleType of
      [< Odoc_xref2.Cpath.module_type ]
      * [< Odoc_xref2.Errors.Tools_error.simple_module_type_lookup_error ] ] ]
    option ->
  Odoc_xref2.Errors.kind option

Sourcetype what = [

| `Functor_parameter of Odoc_model.Paths.Identifier.FunctorParameter.t
| `Value of Odoc_model.Paths.Identifier.Value.t
| `Value_path of Odoc_xref2.Cpath.value
| `Class of Odoc_model.Paths.Identifier.Class.t
| `Class_type of Odoc_model.Paths.Identifier.ClassType.t
| `Module of Odoc_model.Paths.Identifier.Module.t
| `Module_type of Odoc_model.Paths.Identifier.Signature.t
| `Module_path of Odoc_xref2.Cpath.module_
| `Module_type_path of Odoc_xref2.Cpath.module_type
| `Module_type_U of Odoc_xref2.Component.ModuleType.U.expr
| `Include of Odoc_xref2.Component.Include.decl
| `Package of Odoc_xref2.Cpath.module_type
| `Type of Odoc_xref2.Cfrag.type_
| `Type_path of Odoc_xref2.Cpath.type_
| `Class_type_path of Odoc_xref2.Cpath.class_type
| `With_module of Odoc_xref2.Cfrag.module_
| `With_module_type of Odoc_xref2.Cfrag.module_type
| `With_type of Odoc_xref2.Cfrag.type_
| `Module_type_expr of Odoc_xref2.Component.ModuleType.expr
| `Module_type_u_expr of Odoc_xref2.Component.ModuleType.U.expr
| `Child_module of string
| `Child_page of string
| `Reference of Odoc_model.Paths.Reference.t

]

Source

val report : 
  what:Odoc_xref2.Errors.what ->
  ?tools_error:
    [< `ApplyNotFunctor
    | `Class_replaced
    | `Find_failure
    | `Fragment_root
    | `Local of
      Odoc_xref2.Env.t * [< Odoc_xref2.Ident.module_ ] & Odoc_xref2.Env.t
                                                         * [< Odoc_xref2.Ident.module_ ]
    | `LocalMT of
      Odoc_xref2.Env.t * [< Odoc_xref2.Ident.module_type ] & Odoc_xref2.Env.t
                                                             * [< Odoc_xref2.Ident.module_type ]
    | `LocalType of
      Odoc_xref2.Env.t * [< Odoc_xref2.Ident.type_ ] & Odoc_xref2.Env.t
                                                       * [< Odoc_xref2.Ident.type_ ]
    | `LocalValue of
      Odoc_xref2.Env.t * [< Odoc_xref2.Ident.value ] & Odoc_xref2.Env.t
                                                       * [< Odoc_xref2.Ident.value ]
    | `Lookup_failure of
      [< Odoc_model.Paths.Identifier.Path.Module.t_pv ]
        Odoc_model.Paths.Identifier.id & [< Odoc_model.Paths.Identifier.Path.Module.t_pv ]
                                           Odoc_model.Paths.Identifier.id
    | `Lookup_failureMT of
      [< Odoc_model.Paths.Identifier.ModuleType.t_pv ]
        Odoc_model.Paths.Identifier.id & [< Odoc_model.Paths.Identifier.ModuleType.t_pv ]
                                           Odoc_model.Paths.Identifier.id
    | `Lookup_failureT of
      [< Odoc_model.Paths.Identifier.Path.Type.t_pv ]
        Odoc_model.Paths.Identifier.id & [< Odoc_model.Paths.Identifier.Path.Type.t_pv ]
                                           Odoc_model.Paths.Identifier.id
    | `Lookup_failureV of
      [< Odoc_model.Paths.Identifier.Value.t_pv ]
        Odoc_model.Paths.Identifier.id & [< Odoc_model.Paths.Identifier.Value.t_pv ]
                                           Odoc_model.Paths.Identifier.id
    | `Lookup_failure_root of Odoc_model.Names.ModuleName.t
    | `OpaqueClass
    | `OpaqueModule
    | `Parent of
      [< Odoc_xref2.Errors.Tools_error.parent_lookup_error ] & [< Odoc_xref2.Errors.Tools_error.parent_lookup_error ]
    | `Parent_expr of
      [< `ApplyNotFunctor
      | `OpaqueModule
      | `Parent of Odoc_xref2.Errors.Tools_error.parent_lookup_error
      | `UnresolvedForwardPath
      | `UnresolvedPath of
        [ `Module of
            Odoc_xref2.Cpath.module_
            * Odoc_xref2.Errors.Tools_error.simple_module_lookup_error
        | `ModuleType of
          Odoc_xref2.Cpath.module_type
          * Odoc_xref2.Errors.Tools_error.simple_module_type_lookup_error ] ] & 
      [< `ApplyNotFunctor
      | `OpaqueModule
      | `Parent of Odoc_xref2.Errors.Tools_error.parent_lookup_error
      | `UnresolvedForwardPath
      | `UnresolvedPath of
        [ `Module of
            Odoc_xref2.Cpath.module_
            * Odoc_xref2.Errors.Tools_error.simple_module_lookup_error
        | `ModuleType of
          Odoc_xref2.Cpath.module_type
          * Odoc_xref2.Errors.Tools_error.simple_module_type_lookup_error ] ]
    | `Parent_module of
      [< Odoc_xref2.Errors.Tools_error.simple_module_lookup_error ] & 
      [< Odoc_xref2.Errors.Tools_error.simple_module_lookup_error ]
    | `Parent_module_type of
      [< Odoc_xref2.Errors.Tools_error.simple_module_type_lookup_error ] & 
      [< Odoc_xref2.Errors.Tools_error.simple_module_type_lookup_error ]
    | `Parent_sig of
      [< `OpaqueModule
      | `UnresolvedForwardPath
      | `UnresolvedOriginalPath of
        Odoc_xref2.Cpath.module_
        * Odoc_xref2.Errors.Tools_error.simple_module_lookup_error
      | `UnresolvedPath of
        [ `Module of
            Odoc_xref2.Cpath.module_
            * Odoc_xref2.Errors.Tools_error.simple_module_lookup_error
        | `ModuleType of
          Odoc_xref2.Cpath.module_type
          * Odoc_xref2.Errors.Tools_error.simple_module_type_lookup_error ] ] & 
      [< `OpaqueModule
      | `UnresolvedForwardPath
      | `UnresolvedOriginalPath of
        Odoc_xref2.Cpath.module_
        * Odoc_xref2.Errors.Tools_error.simple_module_lookup_error
      | `UnresolvedPath of
        [ `Module of
            Odoc_xref2.Cpath.module_
            * Odoc_xref2.Errors.Tools_error.simple_module_lookup_error
        | `ModuleType of
          Odoc_xref2.Cpath.module_type
          * Odoc_xref2.Errors.Tools_error.simple_module_type_lookup_error ] ]
    | `Parent_type of
      [< Odoc_xref2.Errors.Tools_error.simple_type_lookup_error ] & [< 
                                                                    Odoc_xref2.Errors.Tools_error.simple_type_lookup_error ]
    | `Reference of
      [< `Find_by_name of
           [< `Any
           | `Any_path
           | `Asset_path
           | `C
           | `CT
           | `Cons
           | `Field
           | `Label
           | `Module_path
           | `Page
           | `Page_path
           | `S
           | `T
           | `UnboxedField ]
           * string
      | `Lookup_by_name of
        [< `Any
        | `Any_path
        | `Asset_path
        | `C
        | `CT
        | `Cons
        | `Field
        | `Label
        | `Module_path
        | `Page
        | `Page_path
        | `S
        | `T
        | `UnboxedField ]
        * string
      | `Parent of Odoc_xref2.Errors.Tools_error.parent_lookup_error
      | `Path_error of
        [< `Is_directory
        | `Not_found
        | `Wrong_kind of
          Odoc_xref2.Errors.Tools_error.path_kind list
          * Odoc_xref2.Errors.Tools_error.path_kind Wrong_kind ]
        * Odoc_model.Paths.Reference.tag_hierarchy
        * string list
      | `Wrong_kind of
        Odoc_xref2.Errors.Tools_error.reference_kind list
        * Odoc_xref2.Errors.Tools_error.reference_kind ] & [< `Find_by_name of
                                                                [< `Any
                                                                | `Any_path
                                                                | `Asset_path
                                                                | `C
                                                                | `CT
                                                                | `Cons
                                                                | `Field
                                                                | `Label
                                                                | `Module_path
                                                                | `Page
                                                                | `Page_path
                                                                | `S
                                                                | `T
                                                                | `UnboxedField ]
                                                                * string
                                                           | `Lookup_by_name of
                                                             [< `Any
                                                             | `Any_path
                                                             | `Asset_path
                                                             | `C
                                                             | `CT
                                                             | `Cons
                                                             | `Field
                                                             | `Label
                                                             | `Module_path
                                                             | `Page
                                                             | `Page_path
                                                             | `S
                                                             | `T
                                                             | `UnboxedField ]
                                                             * string
                                                           | `Parent of
                                                             Odoc_xref2.Errors.Tools_error.parent_lookup_error
                                                           | `Path_error of
                                                             [< `Is_directory
                                                             | `Not_found
                                                             | `Wrong_kind of
                                                               Odoc_xref2.Errors.Tools_error.path_kind
                                                                 list
                                                               * Odoc_xref2.Errors.Tools_error.path_kind Wrong_kind ]
                                                             * Odoc_model.Paths.Reference.tag_hierarchy
                                                             * string list
                                                           | `Wrong_kind of
                                                             Odoc_xref2.Errors.Tools_error.reference_kind
                                                               list
                                                             * Odoc_xref2.Errors.Tools_error.reference_kind ]
    | `UnresolvedForwardPath
    | `UnresolvedOriginalPath of
      [< Odoc_xref2.Cpath.module_ ]
      * [< Odoc_xref2.Errors.Tools_error.simple_module_lookup_error ] & 
      [< Odoc_xref2.Cpath.module_ ]
      * [< Odoc_xref2.Errors.Tools_error.simple_module_lookup_error ]
    | `UnresolvedPath of
      [< `Module of
           [< Odoc_xref2.Cpath.module_ ]
           * [< Odoc_xref2.Errors.Tools_error.simple_module_lookup_error ]
      | `ModuleType of
        [< Odoc_xref2.Cpath.module_type ]
        * [< Odoc_xref2.Errors.Tools_error.simple_module_type_lookup_error ] ] & 
      [< `Module of
           [< Odoc_xref2.Cpath.module_ ]
           * [< Odoc_xref2.Errors.Tools_error.simple_module_lookup_error ]
      | `ModuleType of
        [< Odoc_xref2.Cpath.module_type ]
        * [< Odoc_xref2.Errors.Tools_error.simple_module_type_lookup_error ] ] ] ->
  [< `Compile | `Expand | `Lookup | `Resolve | `Resolve_module_type ] ->
  unit

Module Odoc_xref2.ErrorsSource

Module `Odoc_xref2.Errors`Source