ocaml 3.09 transition

[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 f421c76c79e145f49506d49074f0a4662c28e08a..a869f182fd333cbe591a13854b3ace1f0b30d515 100644 (file)
--- a/helm/DEVEL/ocaml-http/http_parser_sanity.mli
+++ b/helm/DEVEL/ocaml-http/http_parser_sanity.mli
@@ -2,25 +2,36 @@
 (*
   OCaml HTTP - do it yourself (fully OCaml) HTTP daemon
 
-  Copyright (C) <2002> Stefano Zacchiroli <zack@cs.unibo.it>
+  Copyright (C) <2002-2005> Stefano Zacchiroli <zack@cs.unibo.it>
 
   This program is free software; you can redistribute it and/or modify
-  it under the terms of the GNU General Public License as published by
-  the Free Software Foundation; either version 2 of the License, or
-  (at your option) any later version.
+  it under the terms of the GNU Library General Public License as
+  published by the Free Software Foundation, version 2.
 
   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-  GNU General Public License for more details.
+  GNU Library General Public License for more details.
 
-  You should have received a copy of the GNU General Public License
-  along with this program; if not, write to the Free Software
-  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+  You should have received a copy of the GNU Library General Public
+  License along with this program; if not, write to the Free Software
+  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 *)
@@ -29,5 +40,7 @@ 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