Module `Odoc_xref2.Find`Source

Sourcetype module_ = [

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

]

Sourcetype module_type = [

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

]

Sourcetype datatype = [

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

]

Sourcetype class_ = [

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

]

Sourcetype value = [

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

]

Sourcetype label = [

| `FLabel of Component.Label.t

]

Sourcetype exception_ = [

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

]

Sourcetype extension = [

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

]

Sourcetype substitution = [

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

]

Sourcetype signature = [

| module_
| module_type

]

Sourcetype type_ = [

| datatype
| class_

]

Sourcetype label_parent = [

| signature
| type_

]

Sourcetype constructor = [

| `FConstructor of Component.TypeDecl.Constructor.t

]

Sourcetype polymorphic_constructor = [

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

]

Sourcetype field = [

| `FField of Component.TypeDecl.Field.t

]

Sourcetype any_in_type = [

| constructor
| field
| polymorphic_constructor

]

Sourcetype any_in_type_in_sig = [

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

]

Sourcetype any_in_sig = [

| label_parent
| value
| label
| exception_
| extension
| substitution
| any_in_type_in_sig

]

Sourcetype instance_variable = [

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

]

Sourcetype method_ = [

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

]

Sourcetype any_in_class_sig = [

| instance_variable
| method_

]

Lookup by name, unambiguous

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Sourceval any_in_type : Component.TypeDecl.t -> string -> any_in_type option

Sourceval any_in_typext : Component.Extension.t -> string -> extension option

Source

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

Source

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

Source

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

Maybe ambiguous

Source

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

Sourceval signature_in_sig : Component.Signature.t -> string -> signature list

Source

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

Sourceval label_parent_in_sig : Component.Signature.t -> string -> label_parent list

Sourceval any_in_sig : Component.Signature.t -> string -> any_in_sig list

Source

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

Source

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

Disambiguated lookups, returns the last match.

Source

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

Lookup removed items

Sourcetype removed_type = [

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

]

Sourcetype careful_module = [

| module_
| `FModule_removed of Cpath.module_

]

Sourcetype careful_module_type = [

| module_type
| `FModuleType_removed of Component.ModuleType.expr

]

Sourcetype core_type = [

| `CoreType of Odoc_model.Names.TypeName.t

]

Sourcetype careful_type = [

| type_
| removed_type
| core_type

]

Sourcetype careful_class = [

| class_
| removed_type

]

Source

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

Source

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

Source

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

Source

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

Install

Dune Dependency

Authors

Maintainers

Sources

doc/odoc.xref2/Odoc_xref2/Find/index.html

Module `Odoc_xref2.Find`Source

package odoc

Install

Dune Dependency

Authors

Maintainers

Sources

doc/odoc.xref2/Odoc_xref2/Find/index.html

Module Odoc_xref2.FindSource

Module `Odoc_xref2.Find`Source