package odoc

You can search for identifiers within the package.

in-package search v0.2.0

OCaml documentation generator

Install

sha256=f574dbd28cd0fc3a2b95525c4bb95ddf6d1f6408bb4fe12157fa537884f987fd

sha512=1c545c281a7022a167f028fff8cec6fb3f2f82da0881431be74e7a4281c5353ed83bfbdb4d9d9e08af6755dbe3505c052c5e5b58cdeb08c57aed5e89c0f15e91

type kind = [

]

val pp_kind : Format.formatter -> kind -> unit

val string_of_kind : kind -> string

type t = {

page : Path.t;
anchor : string;
(*
Anchor in page where the element is attached
*)
kind : kind;
(*
What kind of element the path points to. e.g. "module", "module-type", "exception", ...
*)

}

val from_identifier : 
  Odoc_model.Paths.Identifier.t ->
  (t, Error.t) Result.result

val polymorphic_variant : 
  type_ident:Odoc_model.Paths.Identifier.t ->
  Odoc_model.Lang.TypeExpr.Polymorphic_variant.element ->
  t

val extension_decl : Odoc_model.Lang.Extension.t -> t

Anchor for the extension declaration item itself, which doesn't have an identifier in the model.