odoc 2.0.0 · OCaml Package

odoc

module Resolved : sig ... end

module Cpath : sig ... end

include module type of struct include Cpath end

type module_ = [

| `Resolved of Resolved.module_
| `Substituted of module_
| `Local of Ident.path_module * bool
| `Identifier of Odoc_model.Paths.Identifier.Path.Module.t * bool
| `Root of string
| `Forward of string
| `Dot of module_ * string
| `Module of Resolved.parent * Odoc_model.Names.ModuleName.t
| `Apply of module_ * module_

]

and module_type = [

| `Resolved of Resolved.module_type
| `Substituted of module_type
| `Local of Ident.module_type * bool
| `Identifier of Odoc_model.Paths.Identifier.ModuleType.t * bool
| `Dot of module_ * string
| `ModuleType of Resolved.parent * Odoc_model.Names.ModuleTypeName.t

]

and type_ = [

| `Resolved of Resolved.type_
| `Substituted of type_
| `Local of Ident.path_type * bool
| `Identifier of Odoc_model.Paths.Identifier.Path.Type.t * bool
| `Dot of module_ * string
| `Type of Resolved.parent * Odoc_model.Names.TypeName.t
| `Class of Resolved.parent * Odoc_model.Names.ClassName.t
| `ClassType of Resolved.parent * Odoc_model.Names.ClassTypeName.t

]

and class_type = [

| `Resolved of Resolved.class_type
| `Substituted of class_type
| `Local of Ident.path_class_type * bool
| `Identifier of Odoc_model.Paths.Identifier.Path.ClassType.t * bool
| `Dot of module_ * string
| `Class of Resolved.parent * Odoc_model.Names.ClassName.t
| `ClassType of Resolved.parent * Odoc_model.Names.ClassTypeName.t

]

type local_path_error =

| ErrModule of module_
| ErrModuleType of module_type
| ErrType of type_

exception LocalPath of local_path_error

val resolved_module_path_of_cpath : 
  Resolved.module_ ->
  Odoc_model.Paths.Path.Resolved.Module.t

val resolved_module_path_of_cpath_parent : 
  Resolved.parent ->
  Odoc_model.Paths.Path.Resolved.Module.t

val resolved_module_type_path_of_cpath : 
  Resolved.module_type ->
  Odoc_model.Paths.Path.Resolved.ModuleType.t

val resolved_type_path_of_cpath : 
  Resolved.type_ ->
  Odoc_model.Paths.Path.Resolved.Type.t

val resolved_class_type_path_of_cpath : 
  Resolved.class_type ->
  Odoc_model.Paths.Path.Resolved.ClassType.t

val module_path_of_cpath : module_ -> Odoc_model.Paths.Path.Module.t

val module_type_path_of_cpath : 
  module_type ->
  Odoc_model.Paths.Path.ModuleType.t

val type_path_of_cpath : type_ -> Odoc_model.Paths.Path.Type.t

val class_type_path_of_cpath : class_type -> Odoc_model.Paths.Path.ClassType.t

val is_resolved_module_substituted : Resolved.module_ -> bool

val is_resolved_parent_substituted : Resolved.parent -> bool

val is_resolved_module_type_substituted : Resolved.module_type -> bool

val is_resolved_type_substituted : Resolved.type_ -> bool

val is_resolved_class_type_substituted : Resolved.class_type -> bool

val is_module_substituted : module_ -> bool

val is_module_type_substituted : module_type -> bool

val is_type_substituted : type_ -> bool

val is_class_type_substituted : class_type -> bool

val is_module_forward : module_ -> bool

val is_module_hidden : module_ -> bool

val is_resolved_module_hidden : 
  weak_canonical_test:bool ->
  Resolved.module_ ->
  bool

val is_resolved_parent_hidden : 
  weak_canonical_test:bool ->
  Resolved.parent ->
  bool

val is_module_type_hidden : module_type -> bool

val is_resolved_module_type_hidden : Resolved.module_type -> bool

val is_type_hidden : type_ -> bool

val is_resolved_type_hidden : Resolved.type_ -> bool

val is_resolved_class_type_hidden : Resolved.class_type -> bool

val is_class_type_hidden : class_type -> bool

val resolved_module_of_resolved_module_reference : 
  Odoc_model.Paths.Reference.Resolved.Module.t ->
  Resolved.module_

val resolved_module_of_resolved_signature_reference : 
  Odoc_model.Paths.Reference.Resolved.Signature.t ->
  Resolved.module_

val module_of_module_reference : Odoc_model.Paths.Reference.Module.t -> module_

val unresolve_resolved_module_path : Resolved.module_ -> module_

val unresolve_resolved_module_type_path : Resolved.module_type -> module_type

val unresolve_resolved_parent_path : Resolved.parent -> module_

val unresolve_resolved_type_path : Resolved.type_ -> type_

val unresolve_resolved_class_type_path : Resolved.class_type -> class_type

val unresolve_module_path : module_ -> module_

val unresolve_module_type_path : module_type -> module_type

val unresolve_type_path : type_ -> type_

val unresolve_class_type_path : class_type -> class_type

package odoc