summaryrefslogtreecommitdiff
path: root/ocamldoc/odoc_print.mli
diff options
context:
space:
mode:
Diffstat (limited to 'ocamldoc/odoc_print.mli')
-rw-r--r--ocamldoc/odoc_print.mli31
1 files changed, 31 insertions, 0 deletions
diff --git a/ocamldoc/odoc_print.mli b/ocamldoc/odoc_print.mli
new file mode 100644
index 0000000000..0e7cc2f9d8
--- /dev/null
+++ b/ocamldoc/odoc_print.mli
@@ -0,0 +1,31 @@
+(***********************************************************************)
+(* OCamldoc *)
+(* *)
+(* 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 Q Public License version 1.0. *)
+(* *)
+(***********************************************************************)
+
+(* $Id$ *)
+
+(** Printing functions. *)
+
+(** This function takes a Types.type_expr and returns a string.
+ It writes in and flushes [Format.str_formatter].*)
+val string_of_type_expr : Types.type_expr -> string
+
+(** This function returns a string representing a [Types.module_type].
+ @param complete indicates if we must print complete signatures
+ or just [sig end]. Default if [false].
+*)
+val string_of_module_type : ?complete: bool -> Types.module_type -> string
+
+(** This function returns a string representing a [Types.class_type].
+ @param complete indicates if we must print complete signatures
+ or just [object end]. Default if [false].
+*)
+val string_of_class_type : ?complete: bool -> Types.class_type -> string
+