Argot
 
    Introduction     Status     Examples     Manual     Downloads      
         
 

Styles   
Tags   
Search   

 
Styles
The following source will result in this page.
(** This module defines a type to {h do something}.
    {s It is still in development.} *)

type ('a, 'b) t = private 'a list
(** The type of custom lists.
    @typevar 'a type of elements
    @typevar 'b {u phantom type} used to ... *)

val double_if : bool -> ('a, 'b) t -> ('a, 'b) t
(** [f b l] returns values according to the following rules:

{table {caption rules for [f]}
       {row {header [b]} {header result}}
       {row {data [true]}  {data [s]}}
       {row {data [false]} {data [s @ s]}}
       {row {span {else?}}}}

A thorough explanation of the definition is also available
{fold {i once upon a time, ...}} *)

Tags
The following source will result in this page.
(** This module defines a bunch of miscellaneous functions.
    @copyright nobody
    @license gpl3
    @note these functions...
    @stateful a cache is used to speedup... *)

val f : int -> int
(** @alias [succ] *)

val g : int -> int
(** @todo implement this one *)

val h_one : int -> int
(** @threadunsafe to be used if not thread... *)

val h_multi : int -> int
(** @threadsafe to be used if multiple threads... *)

val i : int -> int
(** Tries to...
    @new introduced to...
    @warning empties the cache *)

val j : int -> int
(** Will...
    @bug when passed zero
    @remark will be slow if cache is large *)

Search
It is possible to try the search feature through the enhanced version of the OCaml library reference in two flavors: frame or popup.

Archives with the enhanced library reference of OCaml are available for both flavors on this page.