package odoc

You can search for identifiers within the package.

in-package search v0.2.0

Legend:
Library
Module
Module type
Parameter
Class
Class type

Management of the documentation environment.

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

type t

type builder

val create : 
  ?important_digests:bool ->
  directories:Fs.Directory.t list ->
  builder

Prepare the environment for a given list of include directories

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

val build : builder -> [ `Unit of Unit.t | `Page of Page.t ] -> t

Initialize the environment for the given unit.

val resolver : t -> Root.t DocOck.resolver

Get a resolver from an env

val expander : t -> Root.t DocOck.expander

Get an expander from an env