To focus the search input from anywhere on the page, press the 'S' key.
in-package search v0.1.0
package odoc
-
odoc.compat
-
odoc.loader
-
odoc.model
-
-
odoc.parser
Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
Resolving
This is the part of DocOck handling the resolving of path and references.
val build_resolver :
?equal:(Odoc_model.Root.t -> Odoc_model.Root.t -> bool) ->
?hash:(Odoc_model.Root.t -> int) ->
(string -> lookup_result) ->
(Odoc_model.Root.t ->
(Odoc_model.Lang.Compilation_unit.t, msg) Result.result) ->
(string -> Odoc_model.Root.t option) ->
(Odoc_model.Root.t -> (Odoc_model.Lang.Page.t, msg) Result.result) ->
resolverBuild a resolver. Optionally provide equality and hash on 'a.
val resolve :
resolver ->
Odoc_model.Lang.Compilation_unit.t ->
(Odoc_model.Lang.Compilation_unit.t, [> msg ]) Result.resultval resolve_page :
resolver ->
Odoc_model.Lang.Page.t ->
(Odoc_model.Lang.Page.t, [> msg ]) Result.resultExpansion
This is the part of DocOck in charge of performing substitutions, inlining of includes, etc.
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) ->
expanderBuild an expander. Assumes that it is safe to use Hashtbl.hash and structural equality (=) on 'a.
val expand :
expander ->
Odoc_model.Lang.Compilation_unit.t ->
(Odoc_model.Lang.Compilation_unit.t, [> msg ]) Result.resultMisc.
OCaml's predefined types and exceptions.
val core_types : Odoc_model.Lang.TypeDecl.t listval core_exceptions : Odoc_model.Lang.Exception.t listmodule Lookup : sig ... end