renamed Http_client to Http_user_agent to avoid clashes with Gerd's

[helm.git] / helm / ocaml / getter / http_getter.mli

diff --git a/helm/ocaml/getter/http_getter.mli b/helm/ocaml/getter/http_getter.mli
index a7d12f5a1611e8867d280d5df34bfd9a819665f1..f0b32b3841a700874736dd92a8c42ae28b71b7f4 100644 (file)
--- a/helm/ocaml/getter/http_getter.mli
+++ b/helm/ocaml/getter/http_getter.mli
@@ -37,8 +37,17 @@ val stdout_logger: logger_callback
   (** {2 Getter Web Service interface as API *)
 
 val help: unit -> string
+
+  (** @raise Http_getter_types.Unresolvable_URI _
+  * @raise Http_getter_types.Key_not_found _ *)
 val resolve: string -> string (* uri -> url *)
+
+  (** @raise Http_getter_types.Key_already_in _ *)
 val register: uri:string -> url:string -> unit
+
+  (** @raise Http_getter_types.Key_not_found _ *)
+val unregister: string -> unit
+
 val update: ?logger:logger_callback -> unit -> unit
 val getxml  : ?format:encoding -> ?patch_dtd:bool -> string -> string
 val getxslt : ?patch_dtd:bool -> string -> string
@@ -49,7 +58,9 @@ val add_server: ?logger:logger_callback -> ?position:int -> string -> unit
 val remove_server: ?logger:logger_callback -> int -> unit
 val getalluris: unit -> string list
 val getallrdfuris: [ `Forward | `Backward ] -> string list
-val ls: xml_uri -> ls_item list
+
+  (** @param regexp regular expression (PCRE syntax) over HELM URIs *)
+val ls: string -> ls_item list
 
   (** {2 Shorthands} *)