package odoc

  1. Overview
  2. Docs
OCaml documentation generator

Install

Dune Dependency

Authors

Maintainers

Sources

odoc-2.1.1.tbz
sha256=f574dbd28cd0fc3a2b95525c4bb95ddf6d1f6408bb4fe12157fa537884f987fd
sha512=1c545c281a7022a167f028fff8cec6fb3f2f82da0881431be74e7a4281c5353ed83bfbdb4d9d9e08af6755dbe3505c052c5e5b58cdeb08c57aed5e89c0f15e91

doc/odoc.model/Odoc_model/Root/index.html

Module Odoc_model.Root

A root can be seen as a unique representative of a odoc file.

Roots are used by doc-ock (at the root of every resolved path/identifier/reference) and present at the beginning of every .odoc file.

module Package : sig ... end
module Odoc_file : sig ... end
type t = {
  1. id : Paths.Identifier.OdocId.t;
  2. file : Odoc_file.t;
  3. digest : Digest.t;
}
val equal : t -> t -> bool
val hash : t -> int
val compare : t -> t -> int
val to_string : t -> string
module Hash_table : Hashtbl.S with type key = t
val contains_double_underscore : string -> bool
OCaml

Innovation. Community. Security.