Module `Odoc_xref2.Find`Source

Sourcetype module_ = [

| `FModule of Odoc_model.Names.ModuleName.t * Odoc_xref2.Component.Module.t

]

Sourcetype module_type = [

| `FModuleType of Odoc_model.Names.ModuleTypeName.t * Odoc_xref2.Component.ModuleType.t

]

Sourcetype datatype = [

| `FType of Odoc_model.Names.TypeName.t * Odoc_xref2.Component.TypeDecl.t

]

Sourcetype class_ = [

| `FClass of Odoc_model.Names.TypeName.t * Odoc_xref2.Component.Class.t
| `FClassType of Odoc_model.Names.TypeName.t * Odoc_xref2.Component.ClassType.t

]

Sourcetype value = [

| `FValue of Odoc_model.Names.ValueName.t * Odoc_xref2.Component.Value.t

]

Sourcetype label = [

| `FLabel of Odoc_xref2.Component.Label.t

]

Sourcetype exception_ = [

| `FExn of Odoc_model.Names.ExceptionName.t * Odoc_xref2.Component.Exception.t

]

Sourcetype extension = [

| `FExt of Odoc_xref2.Component.Extension.t * Odoc_xref2.Component.Extension.Constructor.t

]

Sourcetype substitution = [

| `FModule_subst of Odoc_xref2.Component.ModuleSubstitution.t
| `FType_subst of Odoc_xref2.Component.TypeDecl.t
| `FModuleType_subst of Odoc_xref2.Component.ModuleTypeSubstitution.t

]

Sourcetype signature = [

| Odoc_xref2.Find.module_
| Odoc_xref2.Find.module_type

]

Sourcetype type_ = [

| Odoc_xref2.Find.datatype
| Odoc_xref2.Find.class_

]

Sourcetype label_parent = [

| Odoc_xref2.Find.signature
| Odoc_xref2.Find.type_

]

Sourcetype constructor = [

| `FConstructor of Odoc_xref2.Component.TypeDecl.Constructor.t

]

Sourcetype polymorphic_constructor = [

| `FPoly of Odoc_xref2.Component.TypeExpr.Polymorphic_variant.Constructor.t

]

Sourcetype field = [

| `FField of Odoc_xref2.Component.TypeDecl.Field.t

]

Sourcetype unboxed_field = [

| `FUnboxedField of Odoc_xref2.Component.TypeDecl.UnboxedField.t

]

Sourcetype any_in_type = [

| Odoc_xref2.Find.constructor
| Odoc_xref2.Find.field
| Odoc_xref2.Find.unboxed_field
| Odoc_xref2.Find.polymorphic_constructor

]

Sourcetype any_in_type_in_sig = [

| `In_type of Odoc_model.Names.TypeName.t * Odoc_xref2.Component.TypeDecl.t * Odoc_xref2.Find.any_in_type

]

Sourcetype any_in_sig = [

| Odoc_xref2.Find.label_parent
| Odoc_xref2.Find.value
| Odoc_xref2.Find.label
| Odoc_xref2.Find.exception_
| Odoc_xref2.Find.extension
| Odoc_xref2.Find.substitution
| Odoc_xref2.Find.any_in_type_in_sig

]

Sourcetype instance_variable = [

| `FInstance_variable of Odoc_model.Names.InstanceVariableName.t * Odoc_xref2.Component.InstanceVariable.t

]

Sourcetype method_ = [

| `FMethod of Odoc_model.Names.MethodName.t * Odoc_xref2.Component.Method.t

]

Sourcetype any_in_class_sig = [

| Odoc_xref2.Find.instance_variable
| Odoc_xref2.Find.method_

]

Lookup by name, unambiguous

Source

val module_in_sig : 
  Odoc_xref2.Component.Signature.t ->
  Odoc_model.Names.ModuleName.t ->
  Odoc_xref2.Find.module_ option

Source

val type_in_sig : 
  Odoc_xref2.Component.Signature.t ->
  Odoc_model.Names.TypeName.t ->
  Odoc_xref2.Find.type_ option

Source

val datatype_in_sig : 
  Odoc_xref2.Component.Signature.t ->
  Odoc_model.Names.TypeName.t ->
  Odoc_xref2.Find.datatype option

Source

val module_type_in_sig : 
  Odoc_xref2.Component.Signature.t ->
  Odoc_model.Names.ModuleTypeName.t ->
  Odoc_xref2.Find.module_type option

Source

val exception_in_sig : 
  Odoc_xref2.Component.Signature.t ->
  Odoc_model.Names.ExceptionName.t ->
  Odoc_xref2.Find.exception_ option

Source

val extension_in_sig : 
  Odoc_xref2.Component.Signature.t ->
  Odoc_model.Names.ExtensionName.t ->
  Odoc_xref2.Find.extension option

Source

val any_in_type : 
  Odoc_xref2.Component.TypeDecl.t ->
  string ->
  Odoc_xref2.Find.any_in_type option

Source

val any_in_typext : 
  Odoc_xref2.Component.Extension.t ->
  string ->
  Odoc_xref2.Find.extension option

Source

val value_in_sig : 
  Odoc_xref2.Component.Signature.t ->
  Odoc_model.Names.ValueName.t ->
  Odoc_xref2.Find.value option

Source

val method_in_class_signature : 
  Odoc_xref2.Component.ClassSignature.t ->
  Odoc_model.Names.MethodName.t ->
  Odoc_xref2.Find.method_ option

Source

val instance_variable_in_class_signature : 
  Odoc_xref2.Component.ClassSignature.t ->
  Odoc_model.Names.InstanceVariableName.t ->
  Odoc_xref2.Find.instance_variable option

Maybe ambiguous

Source

val class_in_sig : 
  Odoc_xref2.Component.Signature.t ->
  Odoc_model.Names.TypeName.t ->
  Odoc_xref2.Find.class_ list

Source

val signature_in_sig : 
  Odoc_xref2.Component.Signature.t ->
  string ->
  Odoc_xref2.Find.signature list

Source

val label_in_sig : 
  Odoc_xref2.Component.Signature.t ->
  Odoc_model.Names.LabelName.t ->
  Odoc_xref2.Find.label list

Source

val label_parent_in_sig : 
  Odoc_xref2.Component.Signature.t ->
  string ->
  Odoc_xref2.Find.label_parent list

Source

val any_in_sig : 
  Odoc_xref2.Component.Signature.t ->
  string ->
  Odoc_xref2.Find.any_in_sig list

Source

val any_in_type_in_sig : 
  Odoc_xref2.Component.Signature.t ->
  string ->
  Odoc_xref2.Find.any_in_type_in_sig list

Source

val any_in_class_signature : 
  Odoc_xref2.Component.ClassSignature.t ->
  string ->
  Odoc_xref2.Find.any_in_class_sig list

Disambiguated lookups, returns the last match.

Source

val class_in_sig_unambiguous : 
  Odoc_xref2.Component.Signature.t ->
  Odoc_model.Names.TypeName.t ->
  Odoc_xref2.Find.class_ option

Lookup removed items

Sourcetype removed_type = [

| `FType_removed of Odoc_model.Names.TypeName.t * Odoc_xref2.Component.TypeExpr.t * Odoc_xref2.Component.TypeDecl.Equation.t

]

Sourcetype careful_module = [

| Odoc_xref2.Find.module_
| `FModule_removed of Odoc_xref2.Cpath.module_

]

Sourcetype careful_module_type = [

| Odoc_xref2.Find.module_type
| `FModuleType_removed of Odoc_xref2.Component.ModuleType.expr

]

Sourcetype core_type = [

| `CoreType of Odoc_model.Names.TypeName.t

]

Sourcetype careful_type = [

| Odoc_xref2.Find.type_
| Odoc_xref2.Find.removed_type
| Odoc_xref2.Find.core_type

]

Sourcetype careful_class = [

| Odoc_xref2.Find.class_
| Odoc_xref2.Find.removed_type

]

Source

val careful_module_in_sig : 
  Odoc_xref2.Component.Signature.t ->
  Odoc_model.Names.ModuleName.t ->
  Odoc_xref2.Find.careful_module option

Source

val careful_module_type_in_sig : 
  Odoc_xref2.Component.Signature.t ->
  Odoc_model.Names.ModuleTypeName.t ->
  Odoc_xref2.Find.careful_module_type option

Source

val careful_type_in_sig : 
  Odoc_xref2.Component.Signature.t ->
  Odoc_model.Names.TypeName.t ->
  Odoc_xref2.Find.careful_type option

Source

val careful_class_in_sig : 
  Odoc_xref2.Component.Signature.t ->
  Odoc_model.Names.TypeName.t ->
  Odoc_xref2.Find.careful_class option

Module Odoc_xref2.FindSource

Module `Odoc_xref2.Find`Source