- changed license to lgpl

[helm.git] / helm / ocaml / cic / cicParser.mli

diff --git a/helm/ocaml/cic/cicParser.mli b/helm/ocaml/cic/cicParser.mli
index 1eb5a043b8a9405aa045ce5adfd8c499cd84f43b..048df36a360dbe3898f8be1b37bbe9b0070c2571 100644 (file)
--- a/helm/ocaml/cic/cicParser.mli
+++ b/helm/ocaml/cic/cicParser.mli
@@ -36,10 +36,22 @@
 (*                                                                            *)
 (******************************************************************************)
 
-(* given the filename of an xml file of a cic object and it's uri, it returns *)
-(* its internal annotated representation.                                     *)
-val annobj_of_xml : string -> UriManager.uri -> Cic.annobj
+  (** raised for exception received by the getter (i.e. embedded in the source
+  * XML document). Arguments are values of "helm:exception" and
+  * "helm:exception_arg" attributes *)
+exception Getter_failure of string * string
 
-(* given the filename of an xml file of a cic object and it's uri, it returns *)
-(* its internal logical representation.                                       *)
-val obj_of_xml : string -> UriManager.uri -> Cic.obj
+  (** generic parser failure *)
+exception Parser_failure of string
+
+(* given the filename of an xml file of a cic object, it returns              *)
+(* its internal annotated representation. In the case of constants (whose     *)
+(* type is splitted from the body), a second xml file (for the body) must be  *)
+(* provided.                                                                  *)
+val annobj_of_xml : string -> string option -> Cic.annobj
+
+(* given the filename of an xml file of a cic object, it returns              *)
+(* its internal logical representation. In the case of constants (whose       *)
+(* type is splitted from the body), a second xml file (for the body) must be  *)
+(* provided.                                                                  *)
+val obj_of_xml : string -> string option -> Cic.obj