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

[mirror_edk2.git] / StdLib / Include / Protocol / EfiSocket.h

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