blob: dac941e3397d25e240abb95c28e501234e7fa0c5 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
|
(**************************************************************************)
(* *)
(* OCaml *)
(* *)
(* Maxence Guesdon, projet Cristal, INRIA Rocquencourt *)
(* *)
(* Copyright 2001 Institut National de Recherche en Informatique et *)
(* en Automatique. *)
(* *)
(* All rights reserved. This file is distributed under the terms of *)
(* the GNU Lesser General Public License version 2.1, with the *)
(* special exception on linking described in the file LICENSE. *)
(* *)
(**************************************************************************)
(** The functions to get a string from different kinds of elements (types, modules, ...). *)
(** @return the variance and injectivity annotation for the given type and
variance and injectivity information. *)
val string_of_variance : Odoc_type.t_type -> Types.Variance.t -> string
(** This function returns a string to represent the given list of types,
with a given separator.
@param par can be used to force the addition or not of parentheses around the returned string.
*)
val string_of_type_list : ?par: bool -> string -> Types.type_expr list -> string
(** This function returns a string to represent the list of type parameters
for the given type. *)
val string_of_type_param_list : Odoc_type.t_type -> string
(** This function returns a string to represent the list of type parameters
for the given type extension. *)
val string_of_type_extension_param_list : Odoc_extension.t_type_extension -> string
(** This function returns a string to represent the given list of
type parameters of a class or class type,
with a given separator. *)
val string_of_class_type_param_list : Types.type_expr list -> string
(** @return a string to describe the given type. *)
val string_of_type : Odoc_type.t_type -> string
val string_of_record : Odoc_type.record_field list -> string
(** @return a string to display the parameters of the given class,
in the same form as the compiler. *)
val string_of_class_params : Odoc_class.t_class -> string
(** @return a string to describe the given type extension. *)
val string_of_type_extension : Odoc_extension.t_type_extension -> string
(** @return a string to describe the given exception. *)
val string_of_exception : Odoc_exception.t_exception -> string
(** @return a string to describe the given value. *)
val string_of_value : Odoc_value.t_value -> string
(** @return a string to describe the given attribute. *)
val string_of_attribute : Odoc_value.t_attribute -> string
(** @return a string to describe the given method. *)
val string_of_method : Odoc_value.t_method -> string
|
