ocaml 3.09 transition

[helm.git] / helm / ocaml / xml / xmlPushParser.mli

diff --git a/helm/ocaml/xml/xmlPushParser.mli b/helm/ocaml/xml/xmlPushParser.mli
index 0bbd2203d18a953b649d62d998b2043db139e43a..c13481c91e7677d809224cdd741e46199bb8ed0d 100644 (file)
--- a/helm/ocaml/xml/xmlPushParser.mli
+++ b/helm/ocaml/xml/xmlPushParser.mli
@@ -55,15 +55,22 @@ type position = int * int
 
 type xml_parser
 
+  (** raised when a parse error occurs, argument is an error message.
+   * This exception carries no position information, but it should be get using
+   * get_position below *)
+exception Parse_error of string
+
   (** Create a push parser which invokes the given callbacks *)
 val create_parser: callbacks -> xml_parser
 
-  (** Parse XML data from a given source with a given parser *)
+  (** Parse XML data from a given source with a given parser
+    * @raise Parse_error *)
 val parse: xml_parser -> xml_source -> unit
 
-  (** Inform the farser that parsing is completed, needed only when source is
+  (** Inform the parser that parsing is completed, needed only when source is
    * `String, for other sources it is automatically invoked when the end of file
-   * is reached *)
+   * is reached
+   * @raise Parse_error *)
 val final: xml_parser -> unit
 
   (** @return current <line, column> pair *)