- catch libxslt error and debugging messages and return them to the user

[helm.git] / helm / uwobo / uwobo_styles.mli

diff --git a/helm/uwobo/uwobo_styles.mli b/helm/uwobo/uwobo_styles.mli
index 5a0722f033166526ba3f5be4f9bec687fef03133..9d03b0924ba5ed64579e4de3e6b6cfa8398916ef 100644 (file)
--- a/helm/uwobo/uwobo_styles.mli
+++ b/helm/uwobo/uwobo_styles.mli
@@ -26,19 +26,55 @@
  *  http://helm.cs.unibo.it/
  *)
 
-exception Stylesheet_not_found of string;;
-exception Stylesheet_already_in of string;;
+exception Stylesheet_not_found of string ;;
+exception Stylesheet_already_in of string ;;
 
+  (** libxslt's message *)
+type xslt_msg =
+  | LibXsltErrorMsg of string  (** libxslt's error messages *)
+  | LibXsltDebugMsg of string  (** libxslt's debugging messages *)
+type log = xslt_msg list ;;
+
+  (** hold UWOBO styles at runtime *)
 class styles:
   object
-    method add: string -> string -> unit
-    method remove: string -> unit
-    method removeAll: unit
+
+    (** {2 Stylesheets management} *)
+
+      (** add a stylesheet, bound to a given key, to the UWOBO loaded
+      stylesheets
+      @param key key to which the stylesheets will be bound
+      @param uri uri of the stylesheet to be loaded
+      @raise Stylesheet_already_in if key is already bound *)
+    method add: string -> string -> log
+
+      (** remove the stylesheet bound to a given key *)
+    method remove: string -> log
+
+      (** remove all loaded stylesheet *)
+    method removeAll: log
+
+      (** reload the stylesheet bound to a given key *)
+    method reload: string -> log
+
+      (** reload all stylesheets *)
+    method reloadAll: log
+
+    (** {2 Stylesheets usage} *)
+
+      (** @return a list of strings, each string is a textual representation of
+      information related to a loaded stylesheet. This representation includes
+      at least stylesheet's key and URI *)
     method list: string list
-    method reload: string -> unit
-    method reloadAll: unit
+
+      (** @param key_list list of keys
+      @return a pair. First component of the returned pair is an association
+      list that maps given keys to gdome2-xslt processed stylesheets. Second
+      component of the returned pair is an unprocessed version of the
+      stylesheets corresponding to the latest key provided *)
     method get:
       string list ->
         (string * I_gdome_xslt.processed_stylesheet) list * Gdome.document
+
   end