package doc-ock

  1. Overview
  2. Docs
package doc-ock
Legend:
Library
Module
Module type
Parameter
Class
Class type

Normal OCaml paths (i.e. the ones present in types)

module Resolved : sig ... end
type kind = Kind.path
type ('a, 'b) t =
  1. | Resolved : ('a, 'b) Resolved.t -> ('a, 'b) t
  2. | Root : string -> ('a, [< kind Module ]) t
  3. | Forward : string -> ('a, [< kind Module ]) t
  4. | Dot : 'a module_ * string -> ('a, [< kind ]) t
  5. | Apply : 'a module_ * 'a module_ -> ('a, [< kind Module ]) t
and 'a any = ('a, kind) t
and 'a module_ = ('a, Kind.path_module) t
and 'a module_type = ('a, Kind.path_module_type) t
and 'a type_ = ('a, Kind.path_type) t
and 'a class_type = ('a, Kind.path_class_type) t

Creators

val ident_module : 'a Identifier.module_ -> ('a, [< kind Module ]) t
val ident_module_type : 'a Identifier.module_type -> ('a, [< kind ModuleType ]) t
val ident_type : 'a Identifier.type_ -> ('a, [< kind Type ]) t
val ident_class : 'a Identifier.class_ -> ('a, [< kind Class ]) t
val ident_class_type : 'a Identifier.class_type -> ('a, [< kind ClassType ]) t
val module_ : 'a module_ -> string -> ('a, [< kind Module ]) t
val apply : 'a module_ -> 'a module_ -> ('a, [< kind Module ]) t
val module_type : 'a module_ -> string -> ('a, [< kind ModuleType ]) t
val type_ : 'a module_ -> string -> ('a, [< kind Type ]) t
val class_ : 'a module_ -> string -> ('a, [< kind Class ]) t
val class_type_ : 'a module_ -> string -> ('a, [< kind ClassType ]) t

Explicit coercions

val any : ('a, 'b) t -> 'a any
val type_of_class_type : 'a class_type -> 'a type_

Generic operations

val equal : equal:('a -> 'a -> bool) -> ('a, 'b) t -> ('a, 'b) t -> bool
val hash : hash:('a -> int) -> ('a, 'b) t -> int
val sexp_of_t : ('a -> sexp) -> ('a, _) t -> sexp
val is_hidden : ('a, 'b) t -> bool

cf. Resolved.is_hidden

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct