this repo has no description
1(*
2 * Copyright (c) 2016 Thomas Refis <trefis@janestreet.com>
3 *
4 * Permission to use, copy, modify, and distribute this software for any
5 * purpose with or without fee is hereby granted, provided that the above
6 * copyright notice and this permission notice appear in all copies.
7 *
8 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15 *)
16
17open Odoc_model
18
19val compilation_unit : Lang.Compilation_unit.t -> Types.Document.t
20
21val page : Lang.Page.t -> Types.Document.t
22(** Convert compilation unit or page models into a document *)
23
24val implementation :
25 Lang.Implementation.t ->
26 Syntax_highlighter.infos ->
27 string ->
28 Types.Document.t list
29
30val type_expr : ?needs_parentheses:bool -> Lang.TypeExpr.t -> Codefmt.t
31
32val record : Lang.TypeDecl.Field.t list -> Types.DocumentedSrc.one list
33
34val unboxed_record : Lang.TypeDecl.UnboxedField.t list -> Types.DocumentedSrc.one list