jon.recoil.org
this repo has no description
1open Types
2module Lang = Odoc_model.Lang
3
4type rendered_item = DocumentedSrc.t
5
6type text = Codefmt.t
7
8(** HTML generation syntax customization module. See {!ML} and {!Reason}. *)
9module type SYNTAX = sig
10 module Obj : sig
11 val close_tag_closed : string
12
13 val close_tag_extendable : string
14
15 val field_separator : string
16
17 val open_tag_closed : string
18
19 val open_tag_extendable : string
20 end
21
22 module Type : sig
23 val annotation_separator : string
24
25 val handle_constructor_params : text -> text -> text
26
27 val handle_substitution_params : text -> text -> text
28
29 val handle_format_params : text -> text
30
31 val type_def_semicolon : bool
32
33 val private_keyword : string
34
35 val parenthesize_constructor : bool
36
37 module Variant : sig
38 val parenthesize_params : bool
39 end
40
41 module Tuple : sig
42 val element_separator : text
43
44 val always_parenthesize : bool
45 end
46
47 module Record : sig
48 val field_separator : string
49 end
50
51 val var_prefix : string
52
53 val any : string
54
55 val arrow : text
56
57 module Exception : sig
58 val semicolon : bool
59 end
60
61 module GADT : sig
62 val arrow : text
63 end
64
65 module External : sig
66 val semicolon : bool
67
68 val handle_primitives : string list -> Inline.t
69 end
70 end
71
72 module Mod : sig
73 val open_tag : text
74
75 val close_tag : text
76
77 val close_tag_semicolon : bool
78
79 val include_semicolon : bool
80
81 val functor_keyword : bool
82
83 val functor_contraction : bool
84 end
85
86 module Class : sig
87 val open_tag : text
88
89 val close_tag : text
90 end
91
92 module Value : sig
93 val variable_keyword : string
94
95 val semicolon : bool
96 end
97
98 module Comment : sig
99 val markers : string * string
100 end
101end
102
103module type GENERATOR = sig
104 val compilation_unit : Lang.Compilation_unit.t -> Document.t
105
106 val page : Lang.Page.t -> Document.t
107
108 val implementation :
109 Odoc_model.Lang.Implementation.t ->
110 Syntax_highlighter.infos ->
111 string ->
112 Document.t list
113
114 val type_expr : ?needs_parentheses:bool -> Lang.TypeExpr.t -> text
115
116 val record : Lang.TypeDecl.Field.t list -> DocumentedSrc.one list
117
118 val unboxed_record : Lang.TypeDecl.UnboxedField.t list -> DocumentedSrc.one list
119end