Standard Library
Below is the API for the OCaml standard library. It's directly copied over from the OCaml Manual, formatted to the Reason syntax and styled accordingly. The API docs are work-in-progress; we'll be polishing these gradually!
If you're targeting JavaScript, the API docs for BuckleScript includes all of below, plus JS-specific APIs.
sig
val init : unit -> unit
val warn_bad_docstrings : unit -> unit
type docstring
val docstring : string -> Location.t -> Docstrings.docstring
val docstring_body : Docstrings.docstring -> string
val docstring_loc : Docstrings.docstring -> Location.t
val set_pre_docstrings :
Lexing.position -> Docstrings.docstring list -> unit
val set_post_docstrings :
Lexing.position -> Docstrings.docstring list -> unit
val set_floating_docstrings :
Lexing.position -> Docstrings.docstring list -> unit
val set_pre_extra_docstrings :
Lexing.position -> Docstrings.docstring list -> unit
val set_post_extra_docstrings :
Lexing.position -> Docstrings.docstring list -> unit
type docs = {
docs_pre : Docstrings.docstring option;
docs_post : Docstrings.docstring option;
}
val empty_docs : Docstrings.docs
val docs_attr : Docstrings.docstring -> Parsetree.attribute
val add_docs_attrs :
Docstrings.docs -> Parsetree.attributes -> Parsetree.attributes
val symbol_docs : unit -> Docstrings.docs
val symbol_docs_lazy : unit -> Docstrings.docs Lazy.t
val rhs_docs : int -> int -> Docstrings.docs
val rhs_docs_lazy : int -> int -> Docstrings.docs Lazy.t
val mark_symbol_docs : unit -> unit
val mark_rhs_docs : int -> int -> unit
type info = Docstrings.docstring option
val empty_info : Docstrings.info
val info_attr : Docstrings.docstring -> Parsetree.attribute
val add_info_attrs :
Docstrings.info -> Parsetree.attributes -> Parsetree.attributes
val symbol_info : unit -> Docstrings.info
val rhs_info : int -> Docstrings.info
type text = Docstrings.docstring list
val empty_text : Docstrings.text
val text_attr : Docstrings.docstring -> Parsetree.attribute
val add_text_attrs :
Docstrings.text -> Parsetree.attributes -> Parsetree.attributes
val symbol_text : unit -> Docstrings.text
val symbol_text_lazy : unit -> Docstrings.text Lazy.t
val rhs_text : int -> Docstrings.text
val rhs_text_lazy : int -> Docstrings.text Lazy.t
val symbol_pre_extra_text : unit -> Docstrings.text
val symbol_post_extra_text : unit -> Docstrings.text
val rhs_pre_extra_text : int -> Docstrings.text
val rhs_post_extra_text : int -> Docstrings.text
end