first moogle template checkin

[helm.git] / helm / DEVEL / ocaml-http / http_parser_sanity.mli

diff --git a/helm/DEVEL/ocaml-http/http_parser_sanity.mli b/helm/DEVEL/ocaml-http/http_parser_sanity.mli
index 3076a42a62902d49c0a393d76733fb6d3e49add7..2603d7da9114daa48c19fb837945fcf6aa1df020 100644 (file)
--- a/helm/DEVEL/ocaml-http/http_parser_sanity.mli
+++ b/helm/DEVEL/ocaml-http/http_parser_sanity.mli
@@ -19,13 +19,28 @@
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *)
 
+(** Sanity test functions related to HTTP message parsing *)
+
+  (** @param name an HTTP header name
+  @raise Invalid_header_name if name isn't a valid HTTP header name *)
 val heal_header_name: string -> unit
+
+  (** @param value an HTTP header value
+  @raise Invalid_header_value if value isn't a valid HTTP header value *)
 val heal_header_value: string -> unit
+
+  (** @param header a pair header_name * header_value
+  @raise Invalid_header_name if name isn't a valid HTTP header name
+  @raise Invalid_header_value if value isn't a valid HTTP header value *)
 val heal_header: string * string -> unit
 
   (** remove heading and/or trailing LWS sequences as per RFC2616 *)
 val normalize_header_value: string -> string
 
+  (** parse an URL from a string.
+  @raise Malformed_URL if an invalid URL is encountered *)
 val url_of_string: string -> Neturl.url
+
+  (** pretty print an URL *)
 val string_of_url: Neturl.url -> string