package odoc

You can search for identifiers within the package.

in-package search v0.2.0

OCaml documentation generator

Install

Dune Dependency

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

Authors

Maintainers

J

Jon Ludlam <jon@recoil.org>

Sources

odoc-2.1.1.tbz

sha256=f574dbd28cd0fc3a2b95525c4bb95ddf6d1f6408bb4fe12157fa537884f987fd

sha512=1c545c281a7022a167f028fff8cec6fb3f2f82da0881431be74e7a4281c5353ed83bfbdb4d9d9e08af6755dbe3505c052c5e5b58cdeb08c57aed5e89c0f15e91

doc/odoc.odoc/Odoc_odoc/Resolver/index.html

Module `Odoc_odoc.Resolver`

Management of the documentation environment.

This is the module which does the link between packages, directories and Odoc_xref2's needs.

type t

val create : 
  important_digests:bool ->
  directories:Fs.Directory.t list ->
  open_modules:string list ->
  t

Prepare the environment for a given list of include directories

parameter important_digests
indicate whether digests should be compared when odoc_xref2 tries to lookup or fetch a unit. It defaults to true.

val lookup_page : t -> string -> Odoc_model.Lang.Page.t option

val build_env_for_unit : 
  t ->
  linking:bool ->
  Odoc_model.Lang.Compilation_unit.t ->
  Odoc_xref2.Env.t

Initialize the environment for the given module.

val build_env_for_page : t -> Odoc_model.Lang.Page.t -> Odoc_xref2.Env.t

Initialize the environment for the given page.

val build_env_for_reference : t -> Odoc_xref2.Env.t

Initialize the environment for a reference.

val resolve_import : t -> string -> Odoc_model.Root.t option

Similar to Odoc_xref2.Env.lookup_root_module but save work by loading only the root. Only used when resolving imports, which are needed for the link-deps command.