package odoc

  1. Overview
  2. Docs
OCaml documentation generator

Install 

dune-project
 Dependency

github.com Readme Changelog ISC License Edit opam file Versions (4)

Authors

  1. T
    Thomas Refis <trefis@janestreet.com>
  2. D
    David Sheets <sheets@alum.mit.edu>
  3. L
    Leo White <leo@lpw25.net>
  4. Anton Bachin
  5. J
    Jon Ludlam <jon@recoil.org>
  6. J
    Jules Aguillon <juloo.dsi@gmail.com>
  7. L
    Lubega Simon <lubegasimon73@gmail.com>

Maintainers

  1. J
    Jon Ludlam <jon@recoil.org>

Sources

odoc-2.1.1.tbz
sha256=f574dbd28cd0fc3a2b95525c4bb95ddf6d1f6408bb4fe12157fa537884f987fd
sha512=1c545c281a7022a167f028fff8cec6fb3f2f82da0881431be74e7a4281c5353ed83bfbdb4d9d9e08af6755dbe3505c052c5e5b58cdeb08c57aed5e89c0f15e91

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

Module Odoc_xref2.Find

type module_ = [
  1. | `FModule of Odoc_model.Names.ModuleName.t * Component.Module.t
]
type module_type = [
  1. | `FModuleType of Odoc_model.Names.ModuleTypeName.t * Component.ModuleType.t
]
type datatype = [
  1. | `FType of Odoc_model.Names.TypeName.t * Component.TypeDecl.t
]
type class_ = [
  1. | `FClass of Odoc_model.Names.ClassName.t * Component.Class.t
  2. | `FClassType of Odoc_model.Names.ClassTypeName.t * Component.ClassType.t
]
type value = [
  1. | `FValue of Odoc_model.Names.ValueName.t * Component.Value.t
]
type label = [
  1. | `FLabel of Component.Label.t
]
type exception_ = [
  1. | `FExn of Odoc_model.Names.ExceptionName.t * Component.Exception.t
]
type substitution = [
  1. | `FModule_subst of Component.ModuleSubstitution.t
  2. | `FType_subst of Component.TypeDecl.t
  3. | `FModuleType_subst of Component.ModuleTypeSubstitution.t
]
type signature = [
  1. | module_
  2. | module_type
]
type type_ = [
  1. | datatype
  2. | class_
]
type label_parent = [
  1. | signature
  2. | type_
]
type constructor = [
  1. | `FConstructor of Component.TypeDecl.Constructor.t
]
type field = [
  1. | `FField of Component.TypeDecl.Field.t
]
type any_in_type = [
  1. | constructor
  2. | field
]
type any_in_type_in_sig = [
  1. | `In_type of Odoc_model.Names.TypeName.t * Component.TypeDecl.t * any_in_type
]
type instance_variable = [
  1. | `FInstance_variable of Odoc_model.Names.InstanceVariableName.t * Component.InstanceVariable.t
]
type method_ = [
  1. | `FMethod of Odoc_model.Names.MethodName.t * Component.Method.t
]
type any_in_class_sig = [
  1. | instance_variable
  2. | 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

Lookup removed items

type careful_module = [
  1. | module_
  2. | `FModule_removed of Cpath.Resolved.module_
]
type careful_module_type = [
  1. | module_type
  2. | `FModuleType_removed of Component.ModuleType.expr
]
type careful_type = [
  1. | type_
  2. | removed_type
]
type careful_class = [
  1. | class_
  2. | 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