package doc-ock

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type
type 'a resolver
val build_resolver : ?equal:('a -> 'a -> bool) -> ?hash:('a -> int) -> (string -> 'a DocOckComponentTbl.lookup_unit_result) -> ('a -> 'a DocOckTypes.Unit.t) -> (string -> 'a option) -> ('a -> 'a DocOckTypes.Page.t) -> 'a resolver

Lazily extract the components of units. Assumes that it is safe to use Hashtbl.hash and structural equality (=) on 'a.

val resolve : 'a resolver -> 'a DocOckTypes.Unit.t -> 'a DocOckTypes.Unit.t

Try to resolve all paths and references within a unit.

val resolve_page : 'a resolver -> 'a DocOckTypes.Page.t -> 'a DocOckTypes.Page.t

Try to resolve all paths and references within a page.