Fix @return Doxygen commands to be singular instead of plural.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@12094 6f19259b-4bc3-4df7-8a09-765794883524

AppPkg/Applications/Sockets/DataSource/DataSource.c

@@ -131,7 +131,7 @@ ControlCCheck (
   @param [in] pDigit    The address of the next digit
   @param [out] pValue   The address to receive the value
 
-  @returns  Returns the address of the separator
+  @return   Returns the address of the separator
 
 **/
 CHAR8 *
@@ -775,7 +775,7 @@ Tcp4Locate (
     //
     if ( HandleCount <= Tcp4Index ) {
       Tcp4Index = 0;
-    
+
       //
       //  Wait for the next timer tick
       //
@@ -797,7 +797,7 @@ Tcp4Locate (
               htons ( RemoteHostAddress.sin_port ));
       bTcp4Connecting = FALSE;
     }
-    
+
     //
     //  Open the network controller's service protocol
     //
@@ -1110,7 +1110,7 @@ Tcp4Open (
     Status = pTcp4Protocol->Configure ( pTcp4Protocol,
                                         &Tcp4ConfigData );
     if ( EFI_ERROR ( Status )) {
-      DEBUG (( DEBUG_ERROR, 
+      DEBUG (( DEBUG_ERROR,
                 "ERROR - Failed to configure TCP port, Status: %r\r\n",
                 Status ));
       break;

StdLib/BsdSocketLib/SocketInternals.h

@@ -57,7 +57,7 @@
                             address for the file
   @param [in] pErrno        Address of the errno variable
 
-  @returns  A pointer to the socket protocol structure or NULL if
+  @return   A pointer to the socket protocol structure or NULL if
             an invalid file descriptor was passed in.
 
  **/
@@ -73,7 +73,7 @@ BslFdToSocketProtocol (
 
   @param [in] pDescriptor Descriptor address for the file
 
-  @returns  This routine returns 0 upon success and -1 upon failure.
+  @return   This routine returns 0 upon success and -1 upon failure.
             In the case of failure, errno contains more information.
 
 **/
@@ -105,7 +105,7 @@ BslSocketCloseWork (
 
   @param [in] Events      Mask of events to detect
 
-  @returns    Detected events for the socket
+  @return     Detected events for the socket
 
  **/
 short
@@ -121,7 +121,7 @@ BslSocketPoll (
 
   @param [in] pErrno            Address of the errno variable
 
-  @returns The file descriptor for the socket or -1 if an error occurs.
+  @return  The file descriptor for the socket or -1 if an error occurs.
 
  **/
 int
@@ -138,7 +138,7 @@ BslSocketProtocolToFd (
   @param [in] LengthInBytes Number of bytes to read
   @param [in] pBuffer       Address of the buffer to receive the data
 
-  @returns  The number of bytes read or -1 if an error occurs.
+  @return   The number of bytes read or -1 if an error occurs.
 
 **/
 ssize_t
@@ -157,7 +157,7 @@ BslSocketRead (
   @param [in] LengthInBytes Number of bytes to write
   @param [in] pBuffer       Address of the data
 
-  @returns  The number of bytes written or -1 if an error occurs.
+  @return   The number of bytes written or -1 if an error occurs.
 
 **/
 ssize_t
@@ -175,7 +175,7 @@ BslSocketWrite (
 
   @param [in] pErrno      Address of the errno variable
 
-  @returns  A pointer to the socket protocol structure or NULL if
+  @return   A pointer to the socket protocol structure or NULL if
             an invalid file descriptor was passed in.
 
  **/

StdLib/BsdSocketLib/accept.c

@@ -27,7 +27,7 @@
                                 of the remote network address buffer.  Upon return,
                                 contains the length of the remote network address.
 
-  @returns    ::accept returns zero if successful and -1 when an error occurs.
+  @return     ::accept returns zero if successful and -1 when an error occurs.
               In the case of an error, errno contains more details.
 
  **/
@@ -108,7 +108,7 @@ AcceptWork (
                                 of the remote network address buffer.  Upon return,
                                 contains the length of the remote network address.
 
-  @returns    ::accept returns zero if successful and -1 when an error occurs.
+  @return     ::accept returns zero if successful and -1 when an error occurs.
               In the case of an error, errno contains more details.
 
  **/
@@ -139,7 +139,7 @@ accept (
                                 of the remote network address buffer.  Upon return,
                                 contains the length of the remote network address.
 
-  @returns    This routine returns zero if successful and -1 when an error occurs.
+  @return     This routine returns zero if successful and -1 when an error occurs.
               In the case of an error, errno contains more details.
 
  **/

StdLib/BsdSocketLib/bind.c

@@ -22,9 +22,9 @@
   <a href="http://pubs.opengroup.org/onlinepubs/9699919799/functions/bind.html">POSIX</a>
   documentation for the bind routine is available online for reference.
 
-  @param [in] s         Socket file descriptor returned from ::socket.
+  @param[in] s         Socket file descriptor returned from ::socket.
 
-  @param [in] name      Address of a sockaddr structure that contains the
+  @param[in] name      Address of a sockaddr structure that contains the
                         connection point on the local machine.  An IPv4 address
                         of INADDR_ANY specifies that the connection is made to
                         all of the network stacks on the platform.  Specifying a
@@ -34,9 +34,9 @@
                         number from the dynamic range.  Specifying a specific
                         port number causes the network layer to use that port.
 
-  @param [in] namelen   Specifies the length in bytes of the sockaddr structure.
+  @param[in] namelen   Specifies the length in bytes of the sockaddr structure.
 
-  @returns    The bind routine returns zero (0) if successful and -1 upon failure.
+  @return     The bind routine returns zero (0) if successful and -1 upon failure.
 
  **/
 int

StdLib/BsdSocketLib/close.c

@@ -18,9 +18,9 @@
 /**
   Worker routine to close the socket.
 
-  @param [in] pSocketProtocol   Socket protocol structure address
+  @param[in] pSocketProtocol   Socket protocol structure address
 
-  @param [in] pErrno            Address of the errno variable
+  @param[in] pErrno            Address of the errno variable
 
   @retval EFI_SUCCESS   Successfully closed the socket
 
@@ -83,9 +83,9 @@ BslSocketCloseWork (
 /**
   Close the socket
 
-  @param [in] pDescriptor Descriptor address for the file
+  @param[in] pDescriptor Descriptor address for the file
 
-  @returns  This routine returns 0 upon success and -1 upon failure.
+  @return   This routine returns 0 upon success and -1 upon failure.
             In the case of failure, errno contains more information.
 
 **/

StdLib/BsdSocketLib/connect.c

@@ -42,10 +42,10 @@
   @param [in] s         Socket file descriptor returned from ::socket.
 
   @param [in] address   Network address of the remote system
-  
+
   @param [in] address_len Length of the remote network address
 
-  @returns    ::connect returns zero if successful and -1 when an error occurs.
+  @return     ::connect returns zero if successful and -1 when an error occurs.
               In the case of an error, errno contains more details.
 
  **/
@@ -61,7 +61,7 @@ connect (
   struct __filedes * pDescriptor;
   EFI_SOCKET_PROTOCOL * pSocketProtocol;
   EFI_STATUS Status;
-  
+
   //
   //  Locate the context for this socket
   //
@@ -85,7 +85,7 @@ connect (
                                              &errno );
     } while ( bBlocking && ( EFI_NOT_READY == Status ));
   }
-  
+
   //
   //  Return the new socket file descriptor
   //

StdLib/BsdSocketLib/getpeername.c

@@ -29,7 +29,7 @@
 
   @param [in] address_len Length of the remote network address structure
 
-  @returns    ::getpeername returns zero (0) if successful or -1 when an error occurs.
+  @return     ::getpeername returns zero (0) if successful or -1 when an error occurs.
               In the case of an error, errno contains more details.
 
  **/

StdLib/BsdSocketLib/getsockname.c

@@ -29,7 +29,7 @@
 
   @param [in] address_len Length of the local network address structure
 
-  @returns    ::getsockname returns zero (0) if successful or -1 when an error occurs.
+  @return     ::getsockname returns zero (0) if successful or -1 when an error occurs.
               In the case of an error, errno contains more details.
 
  **/

StdLib/BsdSocketLib/listen.c

@@ -31,7 +31,7 @@
                         waiting for the application to call accept.  Connection attempts
                         received while the queue is full are refused.
 
-  @returns    The listen routine returns zero (0) if successful and -1 upon failure.
+  @return     The listen routine returns zero (0) if successful and -1 upon failure.
 
  **/
 int

StdLib/BsdSocketLib/poll.c

@@ -22,7 +22,7 @@
 
   @param [in] Events      Mask of events to detect
 
-  @returns    Detected events for the socket
+  @return     Detected events for the socket
 
  **/
 short

StdLib/BsdSocketLib/read.c

@@ -23,7 +23,7 @@
   @param [in] LengthInBytes Number of bytes to read
   @param [in] pBuffer       Address of the buffer to receive the data
 
-  @returns  The number of bytes read or -1 if an error occurs.
+  @return   The number of bytes read or -1 if an error occurs.
 
 **/
 ssize_t

StdLib/BsdSocketLib/recv.c

@@ -26,12 +26,12 @@
   @param [in] s         Socket file descriptor returned from ::socket.
 
   @param [in] buffer    Address of a buffer to receive the data.
-  
+
   @param [in] length    Length of the buffer in bytes.
 
   @param [in] flags     Message control flags
 
-  @returns    ::recv returns the number of valid bytes in the buffer,
+  @return     ::recv returns the number of valid bytes in the buffer,
               zero if no data was received, and -1 when an error occurs.
               In the case of an error, errno contains more details.
 
@@ -45,7 +45,7 @@ recv (
   )
 {
   ssize_t BytesRead;
-  
+
   //
   //  Receive the data from the remote system
   //

StdLib/BsdSocketLib/recvfrom.c

@@ -26,7 +26,7 @@
   @param [in] s         Socket file descriptor returned from ::socket.
 
   @param [in] buffer    Address of a buffer to receive the data.
-  
+
   @param [in] length    Length of the buffer in bytes.
 
   @param [in] flags     Message control flags
@@ -35,7 +35,7 @@
 
   @param [in] address_len Length of the remote network address structure
 
-  @returns    ::recvfrom returns the number of valid bytes in the buffer,
+  @return     ::recvfrom returns the number of valid bytes in the buffer,
               zero if no data was received, and -1 when an error occurs.
               In the case of an error, errno contains more details.
 

StdLib/BsdSocketLib/send.c

@@ -26,12 +26,12 @@
   @param [in] s         Socket file descriptor returned from ::socket.
 
   @param [in] buffer    Address of a buffer containing the data to send.
-    
+
   @param [in] length    Length of the buffer in bytes.
 
   @param [in] flags     Message control flags
 
-  @returns    ::send returns the number of data bytes that were
+  @return     ::send returns the number of data bytes that were
               sent and -1 when an error occurs.  In the case of
               an error, errno contains more details.
 

StdLib/BsdSocketLib/sendto.c

@@ -26,7 +26,7 @@
   @param [in] s         Socket file descriptor returned from ::socket.
 
   @param [in] buffer    Address of a buffer containing the data to send.
-    
+
   @param [in] length    Length of the buffer in bytes.
 
   @param [in] flags     Message control flags
@@ -35,7 +35,7 @@
 
   @param [in] tolen     Length of remote system address structure
 
-  @returns    ::send returns the number of data bytes that were
+  @return     ::send returns the number of data bytes that were
               sent and -1 when an error occurs.  In the case of
               an error, errno contains more details.
 

StdLib/BsdSocketLib/shutdown.c

@@ -26,8 +26,8 @@
   @param [in] s         Socket file descriptor returned from ::socket.
 
   @param [in] how       Which operations to shutdown
-  
+
-  @returns    ::shutdown returns the zero (0) if successful or -1 when an
+  @return     ::shutdown returns the zero (0) if successful or -1 when an
               error occurs.  In the latter case, errno contains more details.
 
  **/

StdLib/BsdSocketLib/socket.c

@@ -47,7 +47,7 @@ const struct fileops SocketOperations = {
                             address for the file
   @param [in] pErrno        Address of the errno variable
 
-  @returns  A pointer to the socket protocol structure or NULL if
+  @return   A pointer to the socket protocol structure or NULL if
             an invalid file descriptor was passed in.
 
  **/
@@ -101,10 +101,10 @@ BslFdToSocketProtocol (
   Build a file descriptor for a socket.
 
   @param [in] pSocketProtocol   Socket protocol structure address
-  
+
   @param [in] pErrno            Address of the errno variable
 
-  @returns The file descriptor for the socket or -1 if an error occurs.
+  @return  The file descriptor for the socket or -1 if an error occurs.
 
  **/
 int
@@ -194,7 +194,7 @@ BslSocketProtocolToFd (
                           <li>IPPROTO_UDP</li> - This value must be combined with SOCK_DGRAM.</li>
                         </ul>
 
-  @returns This routine returns a file descriptor for the socket.
+  @return  This routine returns a file descriptor for the socket.
 
  **/
 INT32
@@ -250,7 +250,7 @@ socket (
 
   @param [in] pErrno      Address of the errno variable
 
-  @returns  A pointer to the socket protocol structure or NULL if
+  @return   A pointer to the socket protocol structure or NULL if
             an invalid file descriptor was passed in.
 
  **/

StdLib/BsdSocketLib/write.c

@@ -23,7 +23,7 @@
   @param [in] LengthInBytes Number of bytes to write
   @param [in] pBuffer       Address of the data
 
-  @returns  The number of bytes written or -1 if an error occurs.
+  @return   The number of bytes written or -1 if an error occurs.
 
 **/
 ssize_t

StdLib/Include/Protocol/EfiSocket.h

@@ -198,11 +198,11 @@ EFI_STATUS
   @param [in] pSocketProtocol Address of the socket protocol structure.
 
   @param [in] pSockAddr       Network address of the remote system.
-    
+
   @param [in] SockAddrLength  Length in bytes of the network address.
-  
+
   @param [out] pErrno   Address to receive the errno value upon completion.
-  
+
   @retval EFI_SUCCESS   The connection was successfully established.
   @retval EFI_NOT_READY The connection is in progress, call this routine again.
   @retval Others        The connection attempt failed.
@@ -221,7 +221,7 @@ EFI_STATUS
   Get the local address.
 
   @param [in] pSocketProtocol Address of the socket protocol structure.
-  
+
   @param [out] pAddress       Network address to receive the local system address
 
   @param [in,out] pAddressLength  Length of the local network address structure
@@ -244,7 +244,7 @@ EFI_STATUS
   Get the peer address.
 
   @param [in] pSocketProtocol Address of the socket protocol structure.
-  
+
   @param [out] pAddress       Network address to receive the remote system address
 
   @param [in,out] pAddressLength  Length of the remote network address structure
@@ -387,13 +387,13 @@ EFI_STATUS
   documentation is available online.
 
   @param [in] pSocketProtocol Address of the socket protocol structure.
-  
+
   @param [in] Flags           Message control flags
-  
+
   @param [in] BufferLength    Length of the the buffer
-  
+
   @param [in] pBuffer         Address of a buffer to receive the data.
-  
+
   @param [in] pDataLength     Number of received data bytes in the buffer.
 
   @param [out] pAddress       Network address to receive the remote system address
@@ -425,13 +425,13 @@ EFI_STATUS
   remote network connection.
 
   @param [in] pSocketProtocol Address of the socket protocol structure.
-  
+
   @param [in] Flags           Message control flags
-  
+
   @param [in] BufferLength    Length of the the buffer
-  
+
   @param [in] pBuffer         Address of a buffer containing the data to send
-  
+
   @param [in] pDataLength     Address to receive the number of data bytes sent
 
   @param [in] pAddress        Network address of the remote system address
@@ -463,9 +463,9 @@ EFI_STATUS
   operations.
 
   @param [in] pSocketProtocol Address of the socket protocol structure.
-  
+
   @param [in] How             Which operations to stop
-  
+
   @param [out] pErrno         Address to receive the errno value upon completion.
 
   @retval EFI_SUCCESS - Socket operations successfully shutdown
@@ -577,7 +577,7 @@ typedef struct _EFI_SOCKET_PROTOCOL {
                                 of the remote network address buffer.  Upon return,
                                 contains the length of the remote network address.
 
-  @returns    This routine returns zero if successful and -1 when an error occurs.
+  @return     This routine returns zero if successful and -1 when an error occurs.
               In the case of an error, errno contains more details.
 
  **/

StdLib/Include/wchar.h

@@ -510,7 +510,7 @@ wint_t btowc(int c);
     character set whose multibyte character representation is a single byte when in the initial
     shift state.
 
-    @Returns    The wctob function returns EOF if c does not correspond to a multibyte
+    @return     The wctob function returns EOF if c does not correspond to a multibyte
                 character with length one in the initial shift state. Otherwise, it
                 returns the single-byte representation of that character as an
                 unsigned char converted to an int.
@@ -520,7 +520,7 @@ int wctob(wint_t c);
 /** If ps is not a null pointer, the mbsinit function determines whether the
     pointed-to mbstate_t object describes an initial conversion state.
 
-    @Returns    The mbsinit function returns nonzero if ps is a null pointer
+    @return     The mbsinit function returns nonzero if ps is a null pointer
                 or if the pointed-to object describes an initial conversion
                 state; otherwise, it returns zero.
 **/
@@ -564,7 +564,7 @@ size_t mbsrtowcs(wchar_t * __restrict dst, const char ** __restrict src, size_t
     terminating null wide character, the resulting state described is the
     initial conversion state.
 
-    @Returns    If conversion stops because a wide character is reached that
+    @return     If conversion stops because a wide character is reached that
                 does not correspond to a valid multibyte character, an
                 encoding error occurs: the wcsrtombs function stores the
                 value of the macro EILSEQ in errno and returns (size_t)(-1);

StdLib/LibC/Uefi/SysCalls.c

@@ -651,7 +651,7 @@ open(
 
   @param [in] timeout   Length of time in milliseconds to wait for the event
 
-  @returns    The number of file descriptors with detected events.  Zero
+  @return     The number of file descriptors with detected events.  Zero
               indicates that the call timed out and -1 indicates an error.
 
  **/
@@ -1100,12 +1100,12 @@ write  (int fd, const void *buf, size_t nbyte)
 
 /** Gets the current working directory.
 
-  The getcwd() function shall place an absolute pathname of the current 
+  The getcwd() function shall place an absolute pathname of the current
-  working directory in the array pointed to by buf, and return buf. The 
+  working directory in the array pointed to by buf, and return buf. The
-  pathname copied to the array shall contain no components that are 
+  pathname copied to the array shall contain no components that are
-  symbolic links. The size argument is the size in bytes of the character 
+  symbolic links. The size argument is the size in bytes of the character
-  array pointed to by the buf argument. 
+  array pointed to by the buf argument.
-  
+
   @param[in,out] buf    The buffer to fill.
   @param[in]     size   The number of bytes in buffer.
 
@@ -1114,8 +1114,8 @@ write  (int fd, const void *buf, size_t nbyte)
   @retval NULL          Size was 0.
   @return buf           The function completed successfully. See errno for info.
 **/
-char     
+char
-*getcwd (char *buf, size_t size) 
+*getcwd (char *buf, size_t size)
 {
   CONST CHAR16 *Cwd;
 
@@ -1133,7 +1133,7 @@ char
     errno = ERANGE;
     return (NULL);
   }
-  
+
   return (UnicodeStrToAsciiStr(Cwd, buf));
 }