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

Module Odoc_xref2.EnvSource

Sourcetype lookup_unit_result =
  1. | Forward_reference
  2. | Found of Odoc_model.Lang.Compilation_unit.t
Sourcetype path_query = [
  1. | `Path of Odoc_model.Paths.Reference.Hierarchy.t
  2. | `Name of string
]
Sourcetype lookup_error = [
  1. | `Not_found
]
Sourcetype resolver = {
  1. open_units : string list;
  2. lookup_unit : path_query -> (lookup_unit_result, lookup_error) result;
  3. lookup_page : path_query -> (Odoc_model.Lang.Page.t, lookup_error) result;
  4. lookup_asset : path_query -> (Odoc_model.Lang.Asset.t, lookup_error) result;
  5. lookup_impl : string -> Odoc_model.Lang.Implementation.t option;
}
Sourcetype lookup_type =
  1. | Module of Odoc_model.Paths.Identifier.Path.Module.t
  2. | ModuleType of Odoc_model.Paths.Identifier.ModuleType.t
  3. | RootModule of Odoc_model.Names.ModuleName.t * [ `Forward | `Resolved of Digest.t ] option
  4. | ModuleByName of string * Odoc_model.Paths.Identifier.Path.Module.t
  5. | FragmentRoot of int
Sourceval pp_lookup_type_list : Format.formatter -> lookup_type list -> unit
Sourcetype t
Sourceval is_linking : t -> bool
Sourceval with_recorded_lookups : t -> (t -> 'a) -> LookupTypeSet.t * 'a
Sourceval set_resolver : t -> resolver -> t
Sourceval has_resolver : t -> bool
Sourceval id : t -> int
Sourceval empty : t
Sourceval add_fragment_root : Component.Signature.t -> t -> t
Sourceval add_label : Odoc_model.Paths.Identifier.Label.t -> Component.Label.t -> t -> unboxed:bool -> t
Sourceval add_docs : Odoc_model.Comment.docs -> t -> t
Sourceval add_comment : Odoc_model.Comment.docs_or_stop -> t -> t
Sourceval add_module_type_functor_args : Component.ModuleType.t -> Odoc_model.Paths.Identifier.ModuleType.t -> t -> t
Sourceval lookup_fragment_root : t -> (int * Component.Signature.t) option
Sourceval lookup_page_by_name : string -> t -> (Odoc_model.Lang.Page.t, lookup_error) result
Sourceval lookup_page_by_path : Odoc_model.Paths.Reference.Hierarchy.t -> t -> (Odoc_model.Lang.Page.t, lookup_error) result
Sourceval lookup_asset_by_name : string -> t -> (Odoc_model.Lang.Asset.t, lookup_error) result
Sourceval lookup_impl : string -> t -> Odoc_model.Lang.Implementation.t option
Sourceval lookup_root_module : Odoc_model.Names.ModuleName.t -> t -> root option
Sourcetype 'a scope constraint 'a = [< Component.Element.any ]

Target of a lookup

Sourcetype 'a maybe_ambiguous = ('a, [ `Ambiguous of 'a * 'a list | `Not_found ]) result
Sourceval lookup_by_name : 'a scope -> string -> t -> 'a maybe_ambiguous

Lookup an element in Env depending on the given scope. Return Error (`Ambiguous _) when two or more elements match the given scope and name.

Like lookup_by_name but use an identifier as key.

Sourceval add_functor_parameter : Odoc_model.Lang.FunctorParameter.t -> t -> t
Sourceval add_module_arg : Odoc_model.Lang.TypeExpr.Module.t -> t -> t
Sourceval open_class_signature : Odoc_model.Lang.ClassSignature.t -> t -> t
Sourceval open_signature : Odoc_model.Lang.Signature.t -> t -> t
Sourceval open_type_substitution : Odoc_model.Lang.TypeDecl.t -> t -> t
Sourceval open_module_substitution : Odoc_model.Lang.ModuleSubstitution.t -> t -> t
Sourceval open_module_type_substitution : Odoc_model.Lang.ModuleTypeSubstitution.t -> t -> t
Sourceval open_page : Odoc_model.Lang.Page.t -> t -> t

Add a page content to the env.

Sourceval env_of_unit : Odoc_model.Lang.Compilation_unit.t -> linking:bool -> resolver -> t

Create a new env with a module initially opened.

Sourceval env_of_page : Odoc_model.Lang.Page.t -> resolver -> t

Create a new env for a page.

Create a new env for an implementation.

Sourceval env_for_reference : resolver -> t

Create a new env for a reference.

Sourceval env_for_testing : linking:bool -> t

Create a new env for testing purposes

Sourceval inherit_resolver : t -> t

Create an empty environment reusing the same resolver.

Sourceval len : int ref
Sourceval n : int ref
Sourceval should_suppress_warnings : t -> string option -> bool
Sourceval set_warnings_tags : t -> string list -> t
Sourceval verify_lookups : t -> LookupTypeSet.t -> bool