Mailing-List: contact apache-cvs-help@apache.org; run by ezmlm
Precedence: bulk
Reply-To: new-httpd@apache.org
Date: 6 Aug 2000 00:48:15 -0000
Message-ID: <20000806004815.29089.qmail@locus.apache.org>
From: rbb@locus.apache.org
To: apache-2.0-cvs@apache.org
Subject: cvs commit: apache-2.0/src/include http_vhost.h

rbb         00/08/05 17:48:15

  Modified:    src/include http_vhost.h
  Log:
  Update http_vhost.h to use ScanDoc
  
  Revision  Changes    Path
  1.8       +36 -7     apache-2.0/src/include/http_vhost.h
  
  Index: http_vhost.h
  ===================================================================
  RCS file: /home/cvs/apache-2.0/src/include/http_vhost.h,v
  retrieving revision 1.7
  retrieving revision 1.8
  diff -u -r1.7 -r1.8
  --- http_vhost.h	2000/08/02 05:25:29	1.7
  +++ http_vhost.h	2000/08/06 00:48:14	1.8
  @@ -59,29 +59,58 @@
   extern "C" {
   #endif
   
  -/* called before any config is read */
  +/**
  + * @package Virtual Host package
  + */
  +
  +/**
  + * called before any config is read
  + * @param p Pool to allocate out of
  + */
   void ap_init_vhost_config(apr_pool_t *p);
   
  -/* called after the config has been read */
  +/**
  + * called after the config has been read to compile the tables needed to do 
  + * the run-time vhost lookups
  + * @param p The pool to allocate out of
  + * @param main_server The start of the virtual host list
  + */
   void ap_fini_vhost_config(apr_pool_t *p, server_rec *main_server);
   
  -/* handle addresses in <VirtualHost> statement */
  +/**
  + * handle addresses in <VirtualHost> statement
  + * @param p The pool to allocate out of
  + * @param hostname The hostname in the VirtualHost statement
  + * @param s The list of Virtual Hosts.
  + */
   const char *ap_parse_vhost_addrs(apr_pool_t *p, const char *hostname, server_rec *s);
   
   /* handle NameVirtualHost directive */
   const char *ap_set_name_virtual_host (cmd_parms *cmd, void *dummy,
   				      const char *arg);
   
  -/* given an ip address only, give our best guess as to what vhost it is */
  +/**
  + * given an ip address only, give our best guess as to what vhost it is 
  + * @param conn The current connection
  + */
   void ap_update_vhost_given_ip(conn_rec *conn);
   
  -/* The above is never enough, and this is always called after the headers
  - * have been read.  It may change r->server.
  +/**
  + * ap_update_vhost_given_ip is never enough, and this is always called after 
  + * the headers have been read.  It may change r->server.
  + * @param r The current request
    */
   void ap_update_vhost_from_headers(request_rec *r);
   
  -/* return 1 if the host:port matches any of the aliases of r->server
  +/**
  + * Match the host in the header with the hostname of the server for this
  + * request.
  + * @param r The current request
  + * @param host The hostname in the headers
  + * @param port The port from the headers
  + * @return return 1 if the host:port matches any of the aliases of r->server,
    * return 0 otherwise
  + * @deffunc int ap_matches_request_vhost(request_rec *r, const char *host, unsigned port)
    */
   API_EXPORT(int) ap_matches_request_vhost(request_rec *r, const char *host,
       unsigned port);