ocamldoc/odoc_str.mli

   1 (***********************************************************************)
   2 (*                             OCamldoc                                *)
   3 (*                                                                     *)
   4 (*            Maxence Guesdon, projet Cristal, INRIA Rocquencourt      *)
   5 (*                                                                     *)
   6 (*  Copyright 2001 Institut National de Recherche en Informatique et   *)
   7 (*  en Automatique.  All rights reserved.  This file is distributed    *)
   8 (*  under the terms of the Q Public License version 1.0.               *)
   9 (*                                                                     *)
  10 (***********************************************************************)
  11
  12 (* $Id$ *)
  13
  14 (** The functions to get a string from different kinds of elements (types, modules, ...). *)
  15
  16 (** @return the variance string for the given type and (covariant, contravariant) information. *)
  17 val string_of_variance : Odoc_type.t_type -> (bool * bool) -> string
  18
  19 (** This function returns a string to represent the given list of types,
  20    with a given separator.
  21    @param par can be used to force the addition or not of parentheses around the returned string.
  22 *)
  23 val string_of_type_list : ?par: bool -> string -> Types.type_expr list -> string
  24
  25 (** This function returns a string to represent the list of type parameters
  26    for the given type. *)
  27 val string_of_type_param_list : Odoc_type.t_type -> string
  28
  29 (** This function returns a string to represent the given list of
  30    type parameters of a class or class type,
  31    with a given separator. *)
  32 val string_of_class_type_param_list : Types.type_expr list -> string
  33
  34 (** @return a string to describe the given type. *)
  35 val string_of_type : Odoc_type.t_type -> string
  36
  37 (** @return a string to display the parameters of the given class,
  38    in the same form as the compiler. *)
  39 val string_of_class_params : Odoc_class.t_class -> string
  40
  41 (** @return a string to describe the given exception. *)
  42 val string_of_exception : Odoc_exception.t_exception -> string
  43
  44 (** @return a string to describe the given value. *)
  45 val string_of_value : Odoc_value.t_value -> string
  46
  47 (** @return a string to describe the given attribute. *)
  48 val string_of_attribute : Odoc_value.t_attribute -> string
  49
  50 (** @return a string to describe the given method. *)
  51 val string_of_method : Odoc_value.t_method -> string