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/Cpath/index.html

Module Odoc_xref2.CpathSource

Sourcemodule Resolved : sig ... end
Sourcemodule Cpath : sig ... end
include module type of struct include Cpath end
type module_ = [
  1. | `Resolved of Resolved.module_
  2. | `Substituted of module_
  3. | `Local of Ident.path_module * bool
  4. | `Identifier of Odoc_model.Paths.Identifier.Path.Module.t * bool
  5. | `Root of string
  6. | `Forward of string
  7. | `Dot of module_ * string
  8. | `Module of Resolved.parent * Odoc_model.Names.ModuleName.t
  9. | `Apply of module_ * module_
]
and module_type = [
  1. | `Resolved of Resolved.module_type
  2. | `Substituted of module_type
  3. | `Local of Ident.module_type * bool
  4. | `Identifier of Odoc_model.Paths.Identifier.ModuleType.t * bool
  5. | `Dot of module_ * string
  6. | `ModuleType of Resolved.parent * Odoc_model.Names.ModuleTypeName.t
]
and type_ = [
  1. | `Resolved of Resolved.type_
  2. | `Substituted of type_
  3. | `Local of Ident.path_type * bool
  4. | `Identifier of Odoc_model.Paths.Identifier.Path.Type.t * bool
  5. | `Dot of module_ * string
  6. | `Type of Resolved.parent * Odoc_model.Names.TypeName.t
  7. | `Class of Resolved.parent * Odoc_model.Names.ClassName.t
  8. | `ClassType of Resolved.parent * Odoc_model.Names.ClassTypeName.t
]
and class_type = [
  1. | `Resolved of Resolved.class_type
  2. | `Substituted of class_type
  3. | `Local of Ident.path_class_type * bool
  4. | `Identifier of Odoc_model.Paths.Identifier.Path.ClassType.t * bool
  5. | `Dot of module_ * string
  6. | `Class of Resolved.parent * Odoc_model.Names.ClassName.t
  7. | `ClassType of Resolved.parent * Odoc_model.Names.ClassTypeName.t
]
Sourceval is_resolved_module_substituted : Resolved.module_ -> bool
Sourceval is_resolved_parent_substituted : Resolved.parent -> bool
Sourceval is_resolved_module_type_substituted : Resolved.module_type -> bool
Sourceval is_resolved_type_substituted : Resolved.type_ -> bool
Sourceval is_resolved_class_type_substituted : Resolved.class_type -> bool
Sourceval is_module_substituted : module_ -> bool
Sourceval is_module_type_substituted : module_type -> bool
Sourceval is_type_substituted : type_ -> bool
Sourceval is_class_type_substituted : class_type -> bool
Sourceval is_module_forward : module_ -> bool
Sourceval is_module_hidden : module_ -> bool
Sourceval is_resolved_module_hidden : weak_canonical_test:bool -> Resolved.module_ -> bool
Sourceval is_resolved_parent_hidden : weak_canonical_test:bool -> Resolved.parent -> bool
Sourceval is_module_type_hidden : module_type -> bool
Sourceval is_resolved_module_type_hidden : Resolved.module_type -> bool
Sourceval is_type_hidden : type_ -> bool
Sourceval is_resolved_type_hidden : Resolved.type_ -> bool
Sourceval is_resolved_class_type_hidden : Resolved.class_type -> bool
Sourceval is_class_type_hidden : class_type -> bool
Sourceval resolved_module_of_resolved_module_reference : Odoc_model.Paths.Reference.Resolved.Module.t -> Resolved.module_
Sourceval resolved_module_of_resolved_signature_reference : Odoc_model.Paths.Reference.Resolved.Signature.t -> Resolved.module_
Sourceval module_of_module_reference : Odoc_model.Paths.Reference.Module.t -> module_
Sourceval unresolve_resolved_module_path : Resolved.module_ -> module_
Sourceval unresolve_resolved_module_type_path : Resolved.module_type -> module_type
Sourceval unresolve_resolved_parent_path : Resolved.parent -> module_
Sourceval unresolve_resolved_type_path : Resolved.type_ -> type_
Sourceval unresolve_resolved_class_type_path : Resolved.class_type -> class_type
Sourceval unresolve_module_path : module_ -> module_
Sourceval unresolve_module_type_path : module_type -> module_type
Sourceval unresolve_type_path : type_ -> type_
Sourceval unresolve_class_type_path : class_type -> class_type