- changes defaults of getxml (format gzipped, don't patch dtd)

[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 b58c3dcf408ab8037043692445bf12e4dae66748..0b86e730d54eabac028cfb8aea52ec4cbf61ef0b 100644 (file)
--- a/helm/ocaml/getter/http_getter.mli
+++ b/helm/ocaml/getter/http_getter.mli
@@ -49,6 +49,9 @@ val register: uri:string -> url:string -> unit
 val unregister: string -> unit
 
 val update: ?logger:logger_callback -> unit -> unit
+
+  (** @param format defaults to `Gzipped
+   * @param patch_dtd defaults to false *)
 val getxml  : ?format:encoding -> ?patch_dtd:bool -> string -> string
 val getxslt : ?patch_dtd:bool -> string -> string
 val getdtd  : ?patch_dtd:bool -> string -> string
@@ -64,7 +67,7 @@ val ls: string -> ls_item list
 
   (** {2 Shorthands} *)
 
-val getxml'     : UriManager.uri -> string
+val getxml'     : UriManager.uri -> string  (* `Gzipped format, no DTD patch *)
 val resolve'    : UriManager.uri -> string
 val register'   : UriManager.uri -> string -> unit
 val unregister' : UriManager.uri -> unit