Bug 465629: Fixed the comments about PR_EnumerateAddrInfo and
authorwtc%google.com
Fri, 21 Nov 2008 21:19:33 +0000
changeset 4014 3a269221a6f7a2db77aa92da5aa1782c0de89f21
parent 4013 6f286cfdb9266f9d505c2671443273d3a15d9de6
child 4015 420d87ca17c073dfefbbdf82bffdfddeaae0ab1b
push idunknown
push userunknown
push dateunknown
bugs465629
Bug 465629: Fixed the comments about PR_EnumerateAddrInfo and PR_GetCanonNameFromAddrInfo. r=julien.pierre.
pr/include/prnetdb.h
--- a/pr/include/prnetdb.h
+++ b/pr/include/prnetdb.h
@@ -387,17 +387,17 @@ NSPR_API(PRStatus) PR_GetProtoByName(
 **                      for the failure can be retrieved by PR_GetError().
 ***********************************************************************/
 NSPR_API(PRStatus) PR_GetProtoByNumber(
     PRInt32 protocolnumber, char* buffer, PRInt32 bufsize, PRProtoEnt* result);
 
 /***********************************************************************
 ** FUNCTION:
 ** DESCRIPTION: PR_GetAddrInfoByName()
-**  Lookup a host by name. Equivalent to getaddrinfo(host, NULL, ...) of
+**  Look up a host by name. Equivalent to getaddrinfo(host, NULL, ...) of
 **  RFC 3493.
 **
 ** INPUTS:
 **  char *hostname      Character string defining the host name of interest
 **  PRUint16 af         May be PR_AF_UNSPEC or PR_AF_INET.
 **  PRIntn flags        May be either PR_AI_ADDRCONFIG or
 **                      PR_AI_ADDRCONFIG | PR_AI_NOCANONNAME. Include
 **                      PR_AI_NOCANONNAME to suppress the determination of
@@ -433,41 +433,41 @@ NSPR_API(void) PR_FreeAddrInfo(PRAddrInf
 ** FUNCTION:
 ** DESCRIPTION: PR_EnumerateAddrInfo()
 **  A stateless enumerator over a PRAddrInfo handle acquired from
 **  PR_GetAddrInfoByName() to inspect the possible network addresses.
 **
 ** INPUTS:
 **  void *enumPtr       Index pointer of the enumeration. The enumeration
 **                      starts and ends with a value of NULL.
-**  PRAddrInfo *addrInfo
+**  const PRAddrInfo *addrInfo
 **                      The PRAddrInfo handle returned by a successful
 **                      call to PR_GetAddrInfoByName().
 **  PRUint16 port       The port number to be assigned as part of the
 **                      PRNetAddr.
 ** OUTPUTS:
 **  PRNetAddr *result   A pointer to an address structure that will be
 **                      filled in by the call to the enumeration if the
-**                      result of the call is greater than zero.
+**                      result of the call is not NULL.
 ** RETURN:
 **  void*               The value that should be used for the next call
 **                      of the enumerator ('enumPtr'). The enumeration
-**                      is ended if this value is returned NULL.
+**                      is ended if this value is NULL.
 ***********************************************************************/
 NSPR_API(void *) PR_EnumerateAddrInfo(
     void *enumPtr, const PRAddrInfo *addrInfo, PRUint16 port, PRNetAddr *result);
 
 /***********************************************************************
 ** FUNCTION:
 ** DESCRIPTION: PR_GetCanonNameFromAddrInfo()
 **  Extracts the canonical name of the hostname passed to
 **  PR_GetAddrInfoByName().
 **
 ** INPUTS:
-**  PRAddrInfo *addrInfo 
+**  const PRAddrInfo *addrInfo 
 **                      The PRAddrInfo handle returned by a successful
 **                      call to PR_GetAddrInfoByName().
 ** RETURN:
 **  const char *        A const pointer to the canonical hostname stored
 **                      in the given PRAddrInfo handle. This pointer is
 **                      invalidated once the PRAddrInfo handle is destroyed
 **                      by a call to PR_FreeAddrInfo().
 ***********************************************************************/