ocaml 3.09 transition

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

diff --git a/helm/uwobo/uwobo_styles.mli b/helm/uwobo/uwobo_styles.mli
index 5a0722f033166526ba3f5be4f9bec687fef03133..95af2a484bd70cd845021b50d6dab4b6e509048b 100644 (file)
--- a/helm/uwobo/uwobo_styles.mli
+++ b/helm/uwobo/uwobo_styles.mli
@@ -26,19 +26,59 @@
  *  http://helm.cs.unibo.it/
  *)
 
-exception Stylesheet_not_found of string;;
-exception Stylesheet_already_in of string;;
+open Uwobo_common ;;
 
+exception Stylesheet_not_found of string ;;
+exception Stylesheet_already_in of string ;;
+
+  (** hold UWOBO styles at runtime *)
 class styles:
   object
+
+    (** {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 -> unit
+
+      (** remove the stylesheet bound to a given key *)
     method remove: string -> unit
+
+      (** remove all loaded stylesheet *)
     method removeAll: unit
-    method list: string list
+
+      (** reload the stylesheet bound to a given key *)
     method reload: string -> unit
+
+      (** reload all stylesheets *)
     method reloadAll: unit
+
+    (** {2 Stylesheets usage} *)
+
+      (** @return the list of currently loaded stylesheets' keys *)
+    method keys: string list
+
+      (** @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
+
+      (**
+      @param key_list non empty list of keys
+      @param props list of prop
+      @param logger the logger to be used to report errors and warnings
+      @return a pair. The first argument of the pair is an association list
+      that maps given keys to gdome2-xslt processed stylesheets. The last
+      stylesheet xsl:output element is modified according to the given
+      properties. The second argument of the pair is the last unprocessed
+      stylesheet.
+      *)
     method get:
-      string list ->
+      string list -> (string * string) list -> Uwobo_logger.sysLogger ->
         (string * I_gdome_xslt.processed_stylesheet) list * Gdome.document
+
   end