diff options
Diffstat (limited to 'ocamldoc/odoc_str.mli')
| -rw-r--r-- | ocamldoc/odoc_str.mli | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/ocamldoc/odoc_str.mli b/ocamldoc/odoc_str.mli index a06852ebe3..6c9fa820c8 100644 --- a/ocamldoc/odoc_str.mli +++ b/ocamldoc/odoc_str.mli @@ -17,16 +17,18 @@ val string_of_variance : Odoc_type.t_type -> (bool * bool) -> string (** This function returns a string to represent the given list of types, - with a given separator. It writes in and flushes [Format.str_formatter].*) -val string_of_type_list : string -> Types.type_expr list -> string + 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. It writes in and flushes [Format.str_formatter].*) + for the given type. *) val string_of_type_param_list : Odoc_type.t_type -> string (** This function returns a string to represent the given list of type parameters of a class or class type, - with a given separator. It writes in and flushes [Format.str_formatter].*) + with a given separator. *) val string_of_class_type_param_list : Types.type_expr list -> string (** @return a string to describe the given type. *) |