odoc 2.4.2 · OCaml Package

module Tools_error : sig ... end

val is_unexpanded_module_type_of : Tools_error.any -> bool

type kind = [

| `OpaqueModule
| `Root of string

]

val kind_of_module_cpath : 
  [> `Apply of 'a * 'b | `Dot of 'a * 'c | `Root of 'd | `Substituted of 'a ] as 'a ->
  [> `Root of 'd ] option

val kind_of_module_type_cpath : 
  [> `Dot of
       [> `Apply of 'b * 'b
       | `Dot of 'b * 'c
       | `Root of 'd
       | `Substituted of 'b ] as 'b
       * 'e
  | `Substituted of 'a ] as 'a ->
  [> `Root of 'd ] option

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

val kind_of_error : 
  what:
    [> `Include of 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 Env.t * [< Ident.path_module ]
  | `LocalConstructor of Env.t * [< Ident.constructor ]
  | `LocalDataType of Env.t * [< Ident.datatype ]
  | `LocalMT of Env.t * [< Ident.module_type ]
  | `LocalType of Env.t * [< Ident.path_type ]
  | `LocalValue of Env.t * [< Ident.value ]
  | `Lookup_failure of
    [< Odoc_model.Paths.Identifier.Path.Module.t_pv ]
      Odoc_model.Paths.Identifier.id
  | `Lookup_failureC of
    [< Odoc_model.Paths.Identifier.Constructor.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 string
  | `OpaqueClass
  | `OpaqueModule
  | `Parent of [< Tools_error.parent_lookup_error ]
  | `ParentC of [< Tools_error.simple_datatype_lookup_error ]
  | `Parent_expr of
    [< `ApplyNotFunctor
    | `OpaqueModule
    | `Parent of Tools_error.parent_lookup_error
    | `UnresolvedForwardPath
    | `UnresolvedPath of
      [ `Module of Cpath.module_ * Tools_error.simple_module_lookup_error
      | `ModuleType of
        Cpath.module_type * Tools_error.simple_module_type_lookup_error ] ]
  | `Parent_module of [< Tools_error.simple_module_lookup_error ]
  | `Parent_module_type of [< Tools_error.simple_module_type_lookup_error ]
  | `Parent_sig of
    [< `OpaqueModule
    | `UnexpandedTypeOf of Component.ModuleType.type_of_desc
    | `UnresolvedForwardPath
    | `UnresolvedPath of
      [ `Module of Cpath.module_ * Tools_error.simple_module_lookup_error
      | `ModuleType of
        Cpath.module_type * Tools_error.simple_module_type_lookup_error ] ]
  | `Parent_type of [< Tools_error.simple_type_lookup_error ]
  | `Reference of
    [< `Find_by_name of
         [< `Any | `C | `CT | `Cons | `Field | `Label | `Page | `S | `T ]
         * string
    | `Lookup_by_name of
      [< `Any | `C | `CT | `Cons | `Field | `Label | `Page | `S | `T ] * string
    | `Parent of Tools_error.parent_lookup_error
    | `Wrong_kind of
      Tools_error.reference_kind list * Tools_error.reference_kind ]
  | `UnexpandedTypeOf of Component.ModuleType.type_of_desc
  | `UnresolvedForwardPath
  | `UnresolvedPath of
    [< `Module of
         [< Cpath.module_ ] * [< Tools_error.simple_module_lookup_error ]
    | `ModuleType of
      [< Cpath.module_type ] * [< Tools_error.simple_module_type_lookup_error ] ] ]
    option ->
  kind option

type what = [

| `Functor_parameter of Odoc_model.Paths.Identifier.FunctorParameter.t
| `Value of Odoc_model.Paths.Identifier.Value.t
| `Value_path of 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 Cpath.module_
| `Constructor_path of Cpath.constructor
| `Module_type_path of Cpath.module_type
| `Module_type_U of Component.ModuleType.U.expr
| `Include of Component.Include.decl
| `Package of Cpath.module_type
| `Type of Cfrag.type_
| `Type_path of Cpath.type_
| `Class_type_path of Cpath.class_type
| `With_module of Cfrag.module_
| `With_module_type of Cfrag.module_type
| `With_type of Cfrag.type_
| `Module_type_expr of Component.ModuleType.expr
| `Module_type_u_expr of Component.ModuleType.U.expr
| `Child_module of string
| `Child_page of string
| `Reference of Odoc_model.Paths.Reference.t

]

val report : 
  what:what ->
  ?tools_error:
    [< `ApplyNotFunctor
    | `Class_replaced
    | `Find_failure
    | `Fragment_root
    | `Local of Env.t * [< Ident.path_module ] & Env.t * [< Ident.path_module ]
    | `LocalConstructor of
      Env.t * [< Ident.constructor ] & Env.t * [< Ident.constructor ]
    | `LocalDataType of
      Env.t * [< Ident.datatype ] & Env.t * [< Ident.datatype ]
    | `LocalMT of
      Env.t * [< Ident.module_type ] & Env.t * [< Ident.module_type ]
    | `LocalType of Env.t * [< Ident.path_type ] & Env.t * [< Ident.path_type ]
    | `LocalValue of Env.t * [< Ident.value ] & Env.t * [< 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_failureC of
      [< Odoc_model.Paths.Identifier.Constructor.t_pv ]
        Odoc_model.Paths.Identifier.id & [< Odoc_model.Paths.Identifier.Constructor.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 string
    | `OpaqueClass
    | `OpaqueModule
    | `Parent of
      [< Tools_error.parent_lookup_error ] & [< Tools_error.parent_lookup_error ]
    | `ParentC of
      [< Tools_error.simple_datatype_lookup_error ] & [< Tools_error.simple_datatype_lookup_error ]
    | `Parent_expr of
      [< `ApplyNotFunctor
      | `OpaqueModule
      | `Parent of Tools_error.parent_lookup_error
      | `UnresolvedForwardPath
      | `UnresolvedPath of
        [ `Module of Cpath.module_ * Tools_error.simple_module_lookup_error
        | `ModuleType of
          Cpath.module_type * Tools_error.simple_module_type_lookup_error ] ] & 
      [< `ApplyNotFunctor
      | `OpaqueModule
      | `Parent of Tools_error.parent_lookup_error
      | `UnresolvedForwardPath
      | `UnresolvedPath of
        [ `Module of Cpath.module_ * Tools_error.simple_module_lookup_error
        | `ModuleType of
          Cpath.module_type * Tools_error.simple_module_type_lookup_error ] ]
    | `Parent_module of
      [< Tools_error.simple_module_lookup_error ] & [< Tools_error.simple_module_lookup_error ]
    | `Parent_module_type of
      [< Tools_error.simple_module_type_lookup_error ] & [< Tools_error.simple_module_type_lookup_error ]
    | `Parent_sig of
      [< `OpaqueModule
      | `UnexpandedTypeOf of Component.ModuleType.type_of_desc
      | `UnresolvedForwardPath
      | `UnresolvedPath of
        [ `Module of Cpath.module_ * Tools_error.simple_module_lookup_error
        | `ModuleType of
          Cpath.module_type * Tools_error.simple_module_type_lookup_error ] ] & 
      [< `OpaqueModule
      | `UnexpandedTypeOf of Component.ModuleType.type_of_desc
      | `UnresolvedForwardPath
      | `UnresolvedPath of
        [ `Module of Cpath.module_ * Tools_error.simple_module_lookup_error
        | `ModuleType of
          Cpath.module_type * Tools_error.simple_module_type_lookup_error ] ]
    | `Parent_type of
      [< Tools_error.simple_type_lookup_error ] & [< Tools_error.simple_type_lookup_error ]
    | `Reference of
      [< `Find_by_name of
           [< `Any | `C | `CT | `Cons | `Field | `Label | `Page | `S | `T ]
           * string
      | `Lookup_by_name of
        [< `Any | `C | `CT | `Cons | `Field | `Label | `Page | `S | `T ]
        * string
      | `Parent of Tools_error.parent_lookup_error
      | `Wrong_kind of
        Tools_error.reference_kind list * Tools_error.reference_kind ] & 
      [< `Find_by_name of
           [< `Any | `C | `CT | `Cons | `Field | `Label | `Page | `S | `T ]
           * string
      | `Lookup_by_name of
        [< `Any | `C | `CT | `Cons | `Field | `Label | `Page | `S | `T ]
        * string
      | `Parent of Tools_error.parent_lookup_error
      | `Wrong_kind of
        Tools_error.reference_kind list * Tools_error.reference_kind ]
    | `UnexpandedTypeOf of Component.ModuleType.type_of_desc
    | `UnresolvedForwardPath
    | `UnresolvedPath of
      [< `Module of
           [< Cpath.module_ ] * [< Tools_error.simple_module_lookup_error ]
      | `ModuleType of
        [< Cpath.module_type ]
        * [< Tools_error.simple_module_type_lookup_error ] ] & [< `Module of
                                                                    [< 
                                                                    Cpath.module_ ]
                                                                    * 
                                                                    [< 
                                                                    Tools_error.simple_module_lookup_error ]
                                                               | `ModuleType of
                                                                 [< Cpath.module_type ]
                                                                 * [< 
                                                                   Tools_error.simple_module_type_lookup_error ] ] ] ->
  [< `Compile | `Expand | `Lookup | `Resolve | `Resolve_module_type ] ->
  unit

package odoc