{"schema":1,"title":"API glossary","description":"Kinds, modifiers and package labels in the OCaml API reference.","url":"https://libtmux.org/en/ocaml/latest/reference/glossary/","groups":[{"id":"symbol-kinds","title":"Symbol kinds","description":"Kinds identify declarations in the OCaml API reference.","terms":[{"id":"module","definition":"An OCaml module exposing values, types and nested modules through a signature.","references":[{"title":"OCaml module types","url":"https://ocaml.org/manual/5.5/modtypes.html#s:modtypes"}],"url":"https://libtmux.org/en/ocaml/latest/reference/glossary/#module"},{"id":"interface","definition":"An OCaml module type specifying the declarations a module must provide.","references":[{"title":"OCaml module types","url":"https://ocaml.org/manual/5.5/modtypes.html#s:modtypes"}],"url":"https://libtmux.org/en/ocaml/latest/reference/glossary/#interface"},{"id":"struct","definition":"An OCaml record type with named fields.","references":[{"title":"OCaml type and exception definitions","url":"https://ocaml.org/manual/5.5/typedecl.html#s:tydef"}],"url":"https://libtmux.org/en/ocaml/latest/reference/glossary/#struct"},{"id":"enum","definition":"An OCaml variant type with named constructors, which can carry values.","references":[{"title":"OCaml type and exception definitions","url":"https://ocaml.org/manual/5.5/typedecl.html#s:tydef"}],"url":"https://libtmux.org/en/ocaml/latest/reference/glossary/#enum"},{"id":"function","definition":"An OCaml value with a function type. Arguments are curried and can carry labels or be optional.","references":[{"title":"OCaml expressions","url":"https://ocaml.org/manual/5.5/expr.html#s:value-expr"}],"url":"https://libtmux.org/en/ocaml/latest/reference/glossary/#function"},{"id":"attribute","definition":"A field of an OCaml record. Its module supplies the qualified name; the reference groups it under its declaring type.","references":[{"title":"OCaml type and exception definitions","url":"https://ocaml.org/manual/5.5/typedecl.html#s:tydef"}],"url":"https://libtmux.org/en/ocaml/latest/reference/glossary/#attribute"},{"id":"constant","definition":"A named OCaml value or variant constructor. The signature does not promise a compile-time constant.","references":[{"title":"OCaml module types","url":"https://ocaml.org/manual/5.5/modtypes.html#s:modtypes"}],"url":"https://libtmux.org/en/ocaml/latest/reference/glossary/#constant"},{"id":"typealias","definition":"An OCaml type declaration. A declaration without an equation or representation is abstract.","references":[{"title":"OCaml type and exception definitions","url":"https://ocaml.org/manual/5.5/typedecl.html#s:tydef"}],"url":"https://libtmux.org/en/ocaml/latest/reference/glossary/#typealias"},{"id":"exception","definition":"An OCaml exception constructor.","references":[{"title":"OCaml type and exception definitions","url":"https://ocaml.org/manual/5.5/typedecl.html#s:tydef"}],"url":"https://libtmux.org/en/ocaml/latest/reference/glossary/#exception"}]},{"id":"modifiers","title":"Modifiers","description":"Modifiers add information about calling, implementing, or accessing a declaration. Their precise effect follows the language and the signature.","terms":[{"id":"opaque","definition":"An abstract OCaml type whose representation is hidden by its public signature.","references":[{"title":"OCaml module types","url":"https://ocaml.org/manual/5.5/modtypes.html#s:modtypes"}],"url":"https://libtmux.org/en/ocaml/latest/reference/glossary/#opaque"}]},{"id":"package-context","title":"Package context","description":"Package labels identify where an API is supplied.","terms":[{"id":"package","definition":"An installable OCaml library package. Its public modules supply the declarations in this reference.","detail":"A package name and an OCaml module path are distinct: libtmux-unix provides Libtmux_unix.","references":[{"title":"OCaml libraries with Dune","url":"https://ocaml.org/docs/libraries-dune"}],"url":"https://libtmux.org/en/ocaml/latest/reference/glossary/#package"}]}]}