ocamldoc/odoc_text.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 (** A module with a function to parse strings to obtain a [Odoc_types.text] value. *)
  15
  16 (** Syntax error in a text. *)
  17 exception Text_syntax of int * int * string (* line, char, string *)
  18
  19 (** Transformation of strings to text structures. *)
  20 module Texter :
  21     sig
  22       val text_of_string : string -> Odoc_types.text
  23       val string_of_text : Odoc_types.text -> string
  24     end