odoc 2.3.0 · OCaml Package

odoc

type module_ = [

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

]

type module_type = [

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

]

type datatype = [

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

]

type class_ = [

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

]

type value = [

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

]

type label = [

| `FLabel of Component.Label.t

]

type exception_ = [

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

]

type extension = [

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

]

type substitution = [

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

]

type signature = [

| module_
| module_type

]

type type_ = [

| datatype
| class_

]

type label_parent = [

| signature
| type_

]

type constructor = [

| `FConstructor of Component.TypeDecl.Constructor.t

]

type field = [

| `FField of Component.TypeDecl.Field.t

]

type any_in_type = [

| constructor
| field

]

type any_in_type_in_sig = [

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

]

type any_in_sig = [

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

]

type instance_variable = [

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

]

type method_ = [

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

]

type any_in_class_sig = [

| instance_variable
| method_

]

Lookup by name, unambiguous

val module_in_sig : Component.Signature.t -> string -> module_ option

val type_in_sig : Component.Signature.t -> string -> type_ option

val datatype_in_sig : Component.Signature.t -> string -> datatype option

val module_type_in_sig : Component.Signature.t -> string -> module_type option

val exception_in_sig : Component.Signature.t -> string -> exception_ option

val extension_in_sig : Component.Signature.t -> string -> extension option

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

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

val method_in_class_signature : 
  Component.ClassSignature.t ->
  string ->
  method_ option

val instance_variable_in_class_signature : 
  Component.ClassSignature.t ->
  string ->
  instance_variable option

Maybe ambiguous

val class_in_sig : Component.Signature.t -> string -> class_ list

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

val value_in_sig : Component.Signature.t -> string -> value list

val label_in_sig : Component.Signature.t -> string -> label list

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

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

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

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

Disambiguated lookups, returns the last match.

val class_in_sig_unambiguous : Component.Signature.t -> string -> class_ option

val value_in_sig_unambiguous : Component.Signature.t -> string -> value option

Lookup removed items

type removed_type = [

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

]

type careful_module = [

| module_
| `FModule_removed of Cpath.Resolved.module_

]

type careful_module_type = [

| module_type
| `FModuleType_removed of Component.ModuleType.expr

]

type careful_type = [

| type_
| removed_type

]

type careful_class = [

| class_
| removed_type

]

val careful_module_in_sig : 
  Component.Signature.t ->
  string ->
  careful_module option

val careful_module_type_in_sig : 
  Component.Signature.t ->
  string ->
  careful_module_type option

val careful_type_in_sig : 
  Component.Signature.t ->
  string ->
  careful_type option

val careful_class_in_sig : 
  Component.Signature.t ->
  string ->
  careful_class option

package odoc