Adding comments

[privoxy.git] / src / gateway.c

diff --git a/src/gateway.c b/src/gateway.c
index 6ff762a..22f9f7b 100644 (file)
--- a/src/gateway.c
+++ b/src/gateway.c
@@ -1,7 +1,7 @@
-const char gateway_rcs[] = "$Id: gateway.c,v 1.16 2002/05/12 21:36:29 jongfoster Exp $";
+const char gateway_rcs[] = "$Id: gateway.c,v 2.0 2002/06/04 14:34:21 jongfoster Exp $";
 /*********************************************************************
  *
- * File        :  $Source: /cvsroot/ijbswa/current/gateway.c,v $
+ * File        :  $Source: /cvsroot/ijbswa/current/src/gateway.c,v $
  *
  * Purpose     :  Contains functions to connect to a server, possibly
  *                using a "forwarder" (i.e. HTTP proxy and/or a SOCKS4
@@ -34,6 +34,9 @@ const char gateway_rcs[] = "$Id: gateway.c,v 1.16 2002/05/12 21:36:29 jongfoster
  *
  * Revisions   :
  *    $Log: gateway.c,v $
+ *    Revision 2.0  2002/06/04 14:34:21  jongfoster
+ *    Moving source files to src/
+ *
  *    Revision 1.16  2002/05/12 21:36:29  jongfoster
  *    Correcting function comments
  *
@@ -158,29 +161,38 @@ static jb_socket socks4_connect(const struct forward_spec * fwd,
                                 struct client_state *csp);
 
 
+/** SOCKS command code. */
 #define SOCKS_REQUEST_GRANTED          90
+
+/** SOCKS command code. */
 #define SOCKS_REQUEST_REJECT           91
+
+/** SOCKS command code. */
 #define SOCKS_REQUEST_IDENT_FAILED     92
+
+/** SOCKS command code. */
 #define SOCKS_REQUEST_IDENT_CONFLICT   93
 
-/* structure of a socks client operation */
+
+/** Structure of a socks client operation */
 struct socks_op {
-   unsigned char vn;          /* socks version number */
-   unsigned char cd;          /* command code */
-   unsigned char dstport[2];  /* destination port */
-   unsigned char dstip[4];    /* destination address */
-   unsigned char userid;      /* first byte of userid */
+   unsigned char vn;          /**< Socks version number */
+   unsigned char cd;          /**< Command code */
+   unsigned char dstport[2];  /**< Destination port */
+   unsigned char dstip[4];    /**< Destination address */
+   unsigned char userid;      /**< First byte of userid */
    /* more bytes of the userid follow, terminated by a NULL */
 };
 
-/* structure of a socks server reply */
+/** Structure of a socks server reply */
 struct socks_reply {
-   unsigned char vn;          /* socks version number */
-   unsigned char cd;          /* command code */
-   unsigned char dstport[2];  /* destination port */
-   unsigned char dstip[4];    /* destination address */
+   unsigned char vn;          /**< Socks version number */
+   unsigned char cd;          /**< Command code */
+   unsigned char dstport[2];  /**< Destination port */
+   unsigned char dstip[4];    /**< Destination address */
 };
 
+/** The SOCKS user ID to use */
 static const char socks_userid[] = "anonymous";