API glossary
Kinds, modifiers and package labels in the OCaml API reference. Select an annotation or full API badge to open its definition here.
The signature and entry documentation describe the API’s behavior, including its calling conventions, storage and runtime checks.
Symbol kinds#
Kinds identify declarations in the OCaml API reference.
module#
An OCaml module exposing values, types and nested modules through a signature.
References: OCaml module types .
interface#
An OCaml module type specifying the declarations a module must provide.
References: OCaml module types .
struct#
An OCaml record type with named fields.
References: OCaml type and exception definitions .
enum#
An OCaml variant type with named constructors, which can carry values.
References: OCaml type and exception definitions .
function#
An OCaml value with a function type. Arguments are curried and can carry labels or be optional.
References: OCaml expressions .
attribute#
A field of an OCaml record. Its module supplies the qualified name; the reference groups it under its declaring type.
References: OCaml type and exception definitions .
constant#
A named OCaml value or variant constructor. The signature does not promise a compile-time constant.
References: OCaml module types .
typealias#
An OCaml type declaration. A declaration without an equation or representation is abstract.
References: OCaml type and exception definitions .
exception#
An OCaml exception constructor.
References: OCaml type and exception definitions .
Modifiers#
Modifiers add information about calling, implementing, or accessing a declaration. Their precise effect follows the language and the signature.
opaque#
An abstract OCaml type whose representation is hidden by its public signature.
References: OCaml module types .
Package context#
Package labels identify where an API is supplied.
package#
An installable OCaml library package. Its public modules supply the declarations in this reference.
A package name and an OCaml module path are distinct: libtmux-unix provides Libtmux_unix.
References: OCaml libraries with Dune .