Module `Liquidsoap_lang_data.Doc`

Documentation of builtins, operators and plug-in registries.

Documentation for everything the language exposes to scripts: builtins and operators (Value), plug-in registries (Plug), and the parsing of the ##-style doc comments that feed them.

This is what liquidsoap -h, the website reference and the emacs completions are generated from.

module Value : sig ... end

Documentation of a builtin or an operator.

module Plug : sig ... end

Documentation of a plug-in registry, e.g. protocols or decoders.

val parse_doc : pos:Liquidsoap_lang_prelude.Pos.t -> string -> Value.t option

Parse a ## documentation comment. Returns None when the comment carries no documentation.