package odoc

  1. Overview
  2. Docs
OCaml Documentation Generator

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (5)

Authors

  1. Anton Bachin
  2. Daniel Bünzli
  3. D
    David Sheets <sheets@alum.mit.edu>
  4. J
    Jon Ludlam <jon@recoil.org>
  5. J
    Jules Aguillon <juloo.dsi@gmail.com>
  6. L
    Leo White <leo@lpw25.net>
  7. L
    Lubega Simon <lubegasimon73@gmail.com>
  8. P
    Paul-Elliot Anglès d'Auriac <paul-elliot@tarides.com>
  9. T
    Thomas Refis <trefis@janestreet.com>

Maintainers

  1. Daniel Bünzli
  2. J
    Jon Ludlam <jon@recoil.org>
  3. J
    Jules Aguillon <juloo.dsi@gmail.com>
  4. P
    Paul-Elliot Anglès d'Auriac <paul-elliot@tarides.com>

Sources

odoc-3.2.1.tbz
sha256=d45eb125514839fd9ac27702bb4938d1b4f3b6978e9b16ab9673ea067245affc
sha512=3555386b4770a7caa8ec903683bde5ecdc41d5e57ffaee617d5da225c747bbd1e9c1d2677f4df97e96bbdfc69f580ea83b1b92b933ea40a436a658788b677bbc

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

Module Odoc_xref2.FindSource

Sourcetype module_ = [
  1. | `FModule of Odoc_model.Names.ModuleName.t * Component.Module.t
]
Sourcetype module_type = [
  1. | `FModuleType of Odoc_model.Names.ModuleTypeName.t * Component.ModuleType.t
]
Sourcetype class_ = [
  1. | `FClass of Odoc_model.Names.TypeName.t * Component.Class.t
  2. | `FClassType of Odoc_model.Names.TypeName.t * Component.ClassType.t
]
Sourcetype label = [
  1. | `FLabel of Component.Label.t
]
Sourcetype exception_ = [
  1. | `FExn of Odoc_model.Names.ExceptionName.t * Component.Exception.t
]
Sourcetype substitution = [
  1. | `FModule_subst of Component.ModuleSubstitution.t
  2. | `FType_subst of Component.TypeDecl.t
  3. | `FModuleType_subst of Component.ModuleTypeSubstitution.t
]
Sourcetype signature = [
  1. | module_
  2. | module_type
]
Sourcetype type_ = [
  1. | datatype
  2. | class_
]
Sourcetype label_parent = [
  1. | signature
  2. | type_
]
Sourcetype constructor = [
  1. | `FConstructor of Component.TypeDecl.Constructor.t
]
Sourcetype polymorphic_constructor = [
  1. | `FPoly of Component.TypeExpr.Polymorphic_variant.Constructor.t
]
Sourcetype field = [
  1. | `FField of Component.TypeDecl.Field.t
]
Sourcetype unboxed_field = [
  1. | `FUnboxedField of Component.TypeDecl.UnboxedField.t
]
Sourcetype any_in_type_in_sig = [
  1. | `In_type of Odoc_model.Names.TypeName.t * Component.TypeDecl.t * any_in_type
]
Sourcetype instance_variable = [
  1. | `FInstance_variable of Odoc_model.Names.InstanceVariableName.t * Component.InstanceVariable.t
]
Sourcetype method_ = [
  1. | `FMethod of Odoc_model.Names.MethodName.t * Component.Method.t
]
Sourcetype any_in_class_sig = [
  1. | instance_variable
  2. | method_
]

Lookup by name, unambiguous

Sourceval any_in_type : Component.TypeDecl.t -> string -> any_in_type option
Sourceval any_in_typext : Component.Extension.t -> string -> extension option
Sourceval method_in_class_signature : Component.ClassSignature.t -> Odoc_model.Names.MethodName.t -> method_ option

Maybe ambiguous

Sourceval signature_in_sig : Component.Signature.t -> string -> signature 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
Sourceval any_in_type_in_sig : Component.Signature.t -> string -> any_in_type_in_sig list
Sourceval any_in_class_signature : Component.ClassSignature.t -> string -> any_in_class_sig list

Disambiguated lookups, returns the last match.

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

Lookup removed items

Sourcetype careful_module = [
  1. | module_
  2. | `FModule_removed of Cpath.module_
]
Sourcetype careful_module_type = [
  1. | module_type
  2. | `FModuleType_removed of Component.ModuleType.expr
]
Sourcetype core_type = [
  1. | `CoreType of Odoc_model.Names.TypeName.t
]
Sourcetype careful_type = [
  1. | type_
  2. | removed_type
  3. | core_type
]
Sourcetype careful_class = [
  1. | class_
  2. | removed_type
]