ocaml 3.09 transition

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

diff --git a/helm/DEVEL/ocaml-http/http_daemon.mli b/helm/DEVEL/ocaml-http/http_daemon.mli
index 54b8c19d0d4a998c2275570c8d65635671bc2436..59a408d8755699e2ac3454a3654e245b7625a778 100644 (file)
--- a/helm/DEVEL/ocaml-http/http_daemon.mli
+++ b/helm/DEVEL/ocaml-http/http_daemon.mli
@@ -2,21 +2,21 @@
 (*
   OCaml HTTP - do it yourself (fully OCaml) HTTP daemon
 
-  Copyright (C) <2002-2004> 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
 *)
 
 (** Main OCaml HTTP module.
@@ -140,19 +140,22 @@ val daemon_spec:
 
   (** starts an HTTP daemon (deprecated function)
   *
-  * DEPRECATED, will be removed in future versions, please switch to
-  * Http_daemon.main below.
+  * @deprecated This function will be removed in future versions, please switch
+  * to Http_daemon.main below.
+  *
+  * see {!Http_types.daemon_spec} for a detailed description of parameters
   *
-  * see Http_types.daemon_spec for a detailed description of parameters
   * @param addr like the "address" field of Http_types.daemon_spec, defaults to
   *   the wildcard address "0.0.0.0"
-  * @param like the "port" field of Http_types.daemon_spec, defaults to 80
-  * @param like the "timeout" field of Http_types.daemon_spec, defaults to Some
-  *   300
-  * @param like the "mode" field of Http_types.daemon_spec, defaults to `Fork
-  * @param like the "root_dir" field of Http_types.daemon_spec, defaults to None
+  * @param port like the "port" field of Http_types.daemon_spec, defaults to 80
+  * @param timeout like the "timeout" field of Http_types.daemon_spec, defaults
+  *   to Some 300
+  * @param mode like the "mode" field of Http_types.daemon_spec, defaults to
+  *   `Fork
+  * @param root like the "root_dir" field of Http_types.daemon_spec, defaults to
+  *   None
   * @param callback functional version of the "callback" field of
-  *   Http_types.daemon_spec.  1st argument is the request path, 2nd argument
+  *   Http_types.daemon_spec. 1st argument is the request path, 2nd argument
   *   the decoded query string, 3rd argument an output channel connect to the
   *   client
   *)
@@ -164,11 +167,11 @@ val start:
 
   (** starts an HTTP daemon (deprecated function)
   *
-  * DEPRECATED, will be removed in future versions, please switch to
-  * Http_daemon.main below.
+  * @deprecated This function will be removed in future versions, please switch
+  *   to Http_daemon.main below.
   *
-  * parameters as above except for the callback, in this case it behaves as the
-  * "callback" field of Http_types.daemon_spec
+  * parameters as per {!Http_daemon.start} except for the callback, in this case
+  * it behaves as the "callback" field of Http_types.daemon_spec
   *)
 val start':
   ?addr: string -> ?port: int ->
@@ -177,17 +180,17 @@ val start':
     unit
 
   (** Object oriented interface to HTTP daemons.
-  @param addr address on which daemon will listen for connections
-  @param port port which daemon will bind
-  see {! Http_types.daemon} *)
+  * @param addr address on which daemon will listen for connections
+  * @param port port which daemon will bind
+  * see {!Http_types.daemon} *)
 class daemon:
   ?addr: string -> ?port: int ->
     unit ->
       Http_types.daemon
 
   (** Trivial static pages HTTP daemon.
-  Daemons created using this module will serve directory indexes and files found
-  starting from the working directory *)
+  * Daemons created using this module will serve directory indexes and files
+  * found starting from the working directory *)
 module Trivial :
   sig
       (** callback function, exposed if you like to use it as a basis to define