package odoc

  1. Overview
  2. Docs
package odoc
Legend:
Library
Module
Module type
Parameter
Class
Class type

Resolving

This is the part of DocOck handling the resolving of path and references.

type resolver
type lookup_result_found = {
  1. root : Odoc_model.Root.t;
  2. hidden : bool;
}
type lookup_result =
  1. | Forward_reference
  2. | Found of lookup_result_found
  3. | Not_found
type msg = [
  1. | `Msg of string
]

Build a resolver. Optionally provide equality and hash on 'a.

val resolve_page : resolver -> Odoc_model.Lang.Page.t -> (Odoc_model.Lang.Page.t, [> msg ]) Result.result

Expansion

This is the part of DocOck in charge of performing substitutions, inlining of includes, etc.

type expander
val build_expander : ?equal:(Odoc_model.Root.t -> Odoc_model.Root.t -> bool) -> ?hash:(Odoc_model.Root.t -> int) -> (string -> lookup_result) -> (root:Odoc_model.Root.t -> Odoc_model.Root.t -> (Odoc_model.Lang.Compilation_unit.t, msg) Result.result) -> expander

Build an expander. Assumes that it is safe to use Hashtbl.hash and structural equality (=) on 'a.

Misc.

OCaml's predefined types and exceptions.

val core_types : Odoc_model.Lang.TypeDecl.t list
val core_exceptions : Odoc_model.Lang.Exception.t list
module Lookup : sig ... end