l4/pkg/ocaml/contrib/ocamldoc/odoc_print.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: odoc_print.mli 6173 2004-03-26 09:09:50Z guesdon $ *)
  13
  14 (** Printing functions. *)
  15
  16 (** This function takes a Types.type_expr and returns a string.
  17    It writes in and flushes [Format.str_formatter].*)
  18 val string_of_type_expr : Types.type_expr -> string
  19
  20 (** This function returns a string representing a [Types.module_type].
  21    @param complete indicates if we must print complete signatures
  22    or just [sig end]. Default if [false].
  23    @param code if [complete = false] and the type contains something else
  24    than identificators and functors, then the given code is used.
  25 *)
  26 val string_of_module_type : ?code: string -> ?complete: bool -> Types.module_type -> string
  27
  28 (** This function returns a string representing a [Types.class_type].
  29    @param complete indicates if we must print complete signatures
  30    or just [object end]. Default if [false].
  31 *)
  32 val string_of_class_type : ?complete: bool -> Types.class_type -> string
  33