Module `Odoc_xref2.Cpath`Source

Sourcemodule Resolved : sig ... end

Sourcemodule Cpath : sig ... end

include module type of struct include Odoc_xref2.Cpath.Cpath end

type module_ = [

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

]

and module_type = [

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

]

and type_ = [

| `Resolved of Odoc_xref2.Cpath.Resolved.type_
| `Substituted of Odoc_xref2.Cpath.type_
| `Local of Odoc_xref2.Ident.type_ * bool
| `Identifier of Odoc_model.Paths.Identifier.Path.Type.t * bool
| `DotT of Odoc_xref2.Cpath.module_ * Odoc_model.Names.TypeName.t
| `Type of Odoc_xref2.Cpath.Resolved.parent * Odoc_model.Names.TypeName.t
| `Class of Odoc_xref2.Cpath.Resolved.parent * Odoc_model.Names.TypeName.t
| `ClassType of Odoc_xref2.Cpath.Resolved.parent * Odoc_model.Names.TypeName.t

]

and value = [

| `Resolved of Odoc_xref2.Cpath.Resolved.value
| `DotV of Odoc_xref2.Cpath.module_ * Odoc_model.Names.ValueName.t
| `Value of Odoc_xref2.Cpath.Resolved.parent * Odoc_model.Names.ValueName.t
| `Identifier of Odoc_model.Paths.Identifier.Value.t * bool

]

and class_type = [

| `Resolved of Odoc_xref2.Cpath.Resolved.class_type
| `Substituted of Odoc_xref2.Cpath.class_type
| `Local of Odoc_xref2.Ident.type_ * bool
| `Identifier of Odoc_model.Paths.Identifier.Path.ClassType.t * bool
| `DotT of Odoc_xref2.Cpath.module_ * Odoc_model.Names.TypeName.t
| `Class of Odoc_xref2.Cpath.Resolved.parent * Odoc_model.Names.TypeName.t
| `ClassType of Odoc_xref2.Cpath.Resolved.parent * Odoc_model.Names.TypeName.t

]

Sourceval is_resolved_module_substituted : Odoc_xref2.Cpath.Resolved.module_ -> bool

Sourceval is_resolved_parent_substituted : Odoc_xref2.Cpath.Resolved.parent -> bool

Source

val is_resolved_module_type_substituted : 
  Odoc_xref2.Cpath.Resolved.module_type ->
  bool

Sourceval is_resolved_type_substituted : Odoc_xref2.Cpath.Resolved.type_ -> bool

Source

val is_resolved_class_type_substituted : 
  Odoc_xref2.Cpath.Resolved.class_type ->
  bool

Sourceval is_module_substituted : Odoc_xref2.Cpath.module_ -> bool

Sourceval is_module_type_substituted : Odoc_xref2.Cpath.module_type -> bool

Sourceval is_type_substituted : Odoc_xref2.Cpath.type_ -> bool

Sourceval is_class_type_substituted : Odoc_xref2.Cpath.class_type -> bool

Sourceval is_module_forward : Odoc_xref2.Cpath.module_ -> bool

Sourceval is_module_hidden : Odoc_xref2.Cpath.module_ -> bool

Source

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

Source

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

Sourceval is_module_type_hidden : Odoc_xref2.Cpath.module_type -> bool

Source

val is_resolved_module_type_hidden : 
  Odoc_xref2.Cpath.Resolved.module_type ->
  bool

Sourceval is_type_hidden : Odoc_xref2.Cpath.type_ -> bool

Sourceval is_resolved_type_hidden : Odoc_xref2.Cpath.Resolved.type_ -> bool

Source

val is_resolved_class_type_hidden : 
  Odoc_xref2.Cpath.Resolved.class_type ->
  bool

Sourceval is_class_type_hidden : Odoc_xref2.Cpath.class_type -> bool

Source

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

Source

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

Source

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

Source

val unresolve_resolved_module_path : 
  Odoc_xref2.Cpath.Resolved.module_ ->
  Odoc_xref2.Cpath.module_

Source

val unresolve_module_path : 
  Odoc_xref2.Cpath.module_ ->
  Odoc_xref2.Cpath.module_

Source

val unresolve_resolved_module_type_path : 
  Odoc_xref2.Cpath.Resolved.module_type ->
  Odoc_xref2.Cpath.module_type

Source

val unresolve_resolved_parent_path : 
  Odoc_xref2.Cpath.Resolved.parent ->
  Odoc_xref2.Cpath.module_

Source

val unresolve_resolved_type_path : 
  Odoc_xref2.Cpath.Resolved.type_ ->
  Odoc_xref2.Cpath.type_

Source

val unresolve_resolved_class_type_path : 
  Odoc_xref2.Cpath.Resolved.class_type ->
  Odoc_xref2.Cpath.class_type

Source

val unresolve_module_type_path : 
  Odoc_xref2.Cpath.module_type ->
  Odoc_xref2.Cpath.module_type

Sourceval unresolve_type_path : Odoc_xref2.Cpath.type_ -> Odoc_xref2.Cpath.type_

Source

val unresolve_class_type_path : 
  Odoc_xref2.Cpath.class_type ->
  Odoc_xref2.Cpath.class_type

Module Odoc_xref2.CpathSource

Module `Odoc_xref2.Cpath`Source