ocaml/ocamldoc/odoc_str.mli

29 lines
1.4 KiB
OCaml

(***********************************************************************)
(* 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. *)
(* *)
(***********************************************************************)
(** The functions to get a string from different kinds of elements (types, modules, ...). *)
(** @return a string to describe the given type. *)
val string_of_type : Odoc_type.t_type -> 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