package odoc

  1. Overview
  2. Docs

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. package : Package.t;
  2. file : Odoc_file.t;
  3. digest : Digest.t;
}
val equal : t -> t -> bool
val hash : t -> int
val to_string : t -> string
module Hash_table : Hashtbl.S with type key = t
val contains_double_underscore : string -> bool