ChangeLogTag:Fri Jul 06 11:39:41 2001 Steve Huston <shuston@riverace.com>

1 files changed, 10 insertions, 8 deletions

diff --git a/ace/INET_Addr.h b/ace/INET_Addr.h
index 25f3ad1049c..3f6e6e12a3c 100644
--- a/ace/INET_Addr.h
+++ b/ace/INET_Addr.h
@@ -47,7 +47,8 @@ public:
   ACE_INET_Addr (const sockaddr_in *, int len);
 
   /// Creates an <ACE_INET_Addr> from a <port_number> and the remote
-  /// <host_name>.
+  /// <host_name>. The port number is assumed to be in host byte order.
+  /// To set a port already in network byte order, please @see set().
   ACE_INET_Addr (u_short port_number,
                  const char host_name[]);
 
@@ -63,7 +64,8 @@ public:
   /**
    * Creates an <ACE_INET_Addr> from a <port_number> and an Internet
    * <ip_addr>.  This method assumes that <port_number> and <ip_addr>
-   * are in host byte order.
+   * are in host byte order. If you have addressing information in
+   * network byte order, @see set().
    */
   ACE_INET_Addr (u_short port_number,
 		 ACE_UINT32 ip_addr = INADDR_ANY);
@@ -110,7 +112,7 @@ public:
 
   /**
    * Initializes an <ACE_INET_Addr> from a <port_number> and the
-   * remote <host_name>.  If <encode> is enabled then <port_number> is
+   * remote <host_name>.  If <encode> is non-zero then <port_number> is
    * converted into network byte order, otherwise it is assumed to be
    * in network byte order already and are passed straight through.
    */
@@ -119,11 +121,11 @@ public:
            int encode = 1);
 
   /**
-   * Initializes an <ACE_INET_Addr> from a <port_number> and an
-   * Internet <ip_addr>.  If <encode> is enabled then <port_number>
-   * and <ip_addr> are converted into network byte order, otherwise
-   * they are assumed to be in network byte order already and are
-   * passed straight through.
+   * Initializes an <ACE_INET_Addr> from a @param port_number and an
+   * Internet @param ip_addr.  If @param encode is non-zero then the
+   * port number and IP address are converted into network byte order,
+   * otherwise they are assumed to be in network byte order already and
+   * are passed straight through.
    */
   int set (u_short port_number,
            ACE_UINT32 ip_addr = INADDR_ANY,