fixed a typo (inside a comment)

[helm.git] / helm / hbugs / client / hbugs_client.mli

diff --git a/helm/hbugs/client/hbugs_client.mli b/helm/hbugs/client/hbugs_client.mli
index edf0127bda5b73b2534aa0d1076e37e54c0ce33d..0c2e93d800b81590ab5eb11fcd9e5455f5a28624 100644 (file)
--- a/helm/hbugs/client/hbugs_client.mli
+++ b/helm/hbugs/client/hbugs_client.mli
@@ -1,21 +1,33 @@
 
+open Hbugs_types
+
 exception Invalid_URL of string
 
+  (*
+    @param use_hint_callback is called when the user double click on a hint
+    (default: do nothing)
+    @param describe_hint_callback is called when the user click on a hint
+    (default: do nothing)
+  *)
 class hbugsClient :
-  object
+  ?use_hint_callback: (hint -> unit) ->
+  ?describe_hint_callback: (hint -> unit) ->
+  ?destroy_callback: (unit -> unit) ->
+  unit ->
+    object
 
-    method show : unit -> unit
-    method hide : unit -> unit
+      method show : unit -> unit
+      method hide : unit -> unit
 
-    method startLocalHttpDaemon : unit -> unit
-    method testLocalHttpDaemon : unit -> unit
+      method setUseHintCallback : (hint -> unit) -> unit
+      method registerToBroker : unit -> unit
+      method unregisterFromBroker : unit -> unit
+      method subscribeAll : unit -> unit
 
-    method registerClient : unit -> unit
-    method unregisterClient : unit -> unit
-    method testBroker : unit -> unit
+      method stateChange : state option -> unit
 
-    method stateChange : unit -> unit
-    method useHint : unit -> unit
+        (** @return an hint by index *)
+      method hint : int -> hint
 
-  end
+    end