From 7dc1329100c370992cdd430359512443bd1ee9f2 Mon Sep 17 00:00:00 2001 From: darylm503 Date: Fri, 5 Aug 2011 23:57:34 +0000 Subject: 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 --- StdLib/BsdSocketLib/SocketInternals.h | 14 +++++++------- StdLib/BsdSocketLib/accept.c | 6 +++--- StdLib/BsdSocketLib/bind.c | 8 ++++---- StdLib/BsdSocketLib/close.c | 8 ++++---- StdLib/BsdSocketLib/connect.c | 8 ++++---- StdLib/BsdSocketLib/getpeername.c | 2 +- StdLib/BsdSocketLib/getsockname.c | 2 +- StdLib/BsdSocketLib/listen.c | 2 +- StdLib/BsdSocketLib/poll.c | 2 +- StdLib/BsdSocketLib/read.c | 2 +- StdLib/BsdSocketLib/recv.c | 6 +++--- StdLib/BsdSocketLib/recvfrom.c | 4 ++-- StdLib/BsdSocketLib/send.c | 4 ++-- StdLib/BsdSocketLib/sendto.c | 4 ++-- StdLib/BsdSocketLib/shutdown.c | 4 ++-- StdLib/BsdSocketLib/socket.c | 10 +++++----- StdLib/BsdSocketLib/write.c | 2 +- StdLib/Include/Protocol/EfiSocket.h | 32 ++++++++++++++++---------------- StdLib/Include/wchar.h | 6 +++--- StdLib/LibC/Uefi/SysCalls.c | 20 ++++++++++---------- 20 files changed, 73 insertions(+), 73 deletions(-) (limited to 'StdLib') diff --git a/StdLib/BsdSocketLib/SocketInternals.h b/StdLib/BsdSocketLib/SocketInternals.h index 4f5c584a4e..8fbd8420dc 100644 --- a/StdLib/BsdSocketLib/SocketInternals.h +++ b/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. **/ diff --git a/StdLib/BsdSocketLib/accept.c b/StdLib/BsdSocketLib/accept.c index de8d91f607..25ae1b5861 100644 --- a/StdLib/BsdSocketLib/accept.c +++ b/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. **/ diff --git a/StdLib/BsdSocketLib/bind.c b/StdLib/BsdSocketLib/bind.c index fc24ea420a..c1bf64e9e4 100644 --- a/StdLib/BsdSocketLib/bind.c +++ b/StdLib/BsdSocketLib/bind.c @@ -22,9 +22,9 @@ POSIX 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 diff --git a/StdLib/BsdSocketLib/close.c b/StdLib/BsdSocketLib/close.c index 7d70e4f126..2a9fda4930 100644 --- a/StdLib/BsdSocketLib/close.c +++ b/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. **/ diff --git a/StdLib/BsdSocketLib/connect.c b/StdLib/BsdSocketLib/connect.c index e02762efa3..92fc75bdb0 100644 --- a/StdLib/BsdSocketLib/connect.c +++ b/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 // diff --git a/StdLib/BsdSocketLib/getpeername.c b/StdLib/BsdSocketLib/getpeername.c index 850308a401..37e6d1eab6 100644 --- a/StdLib/BsdSocketLib/getpeername.c +++ b/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. **/ diff --git a/StdLib/BsdSocketLib/getsockname.c b/StdLib/BsdSocketLib/getsockname.c index 0b72edcf29..e8d1d55bb3 100644 --- a/StdLib/BsdSocketLib/getsockname.c +++ b/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. **/ diff --git a/StdLib/BsdSocketLib/listen.c b/StdLib/BsdSocketLib/listen.c index 5e14876652..193444a25c 100644 --- a/StdLib/BsdSocketLib/listen.c +++ b/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 diff --git a/StdLib/BsdSocketLib/poll.c b/StdLib/BsdSocketLib/poll.c index fdf50e8b68..336924d556 100644 --- a/StdLib/BsdSocketLib/poll.c +++ b/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 diff --git a/StdLib/BsdSocketLib/read.c b/StdLib/BsdSocketLib/read.c index eb72f5cbf7..6f8d42974b 100644 --- a/StdLib/BsdSocketLib/read.c +++ b/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 diff --git a/StdLib/BsdSocketLib/recv.c b/StdLib/BsdSocketLib/recv.c index 735e1dbddd..91f07cb08a 100644 --- a/StdLib/BsdSocketLib/recv.c +++ b/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 // diff --git a/StdLib/BsdSocketLib/recvfrom.c b/StdLib/BsdSocketLib/recvfrom.c index a8d1ab54ee..ce230231dc 100644 --- a/StdLib/BsdSocketLib/recvfrom.c +++ b/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. diff --git a/StdLib/BsdSocketLib/send.c b/StdLib/BsdSocketLib/send.c index f3f739cb6f..0bbed5ac33 100644 --- a/StdLib/BsdSocketLib/send.c +++ b/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. diff --git a/StdLib/BsdSocketLib/sendto.c b/StdLib/BsdSocketLib/sendto.c index aa6ea8c14a..5311ce6022 100644 --- a/StdLib/BsdSocketLib/sendto.c +++ b/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. diff --git a/StdLib/BsdSocketLib/shutdown.c b/StdLib/BsdSocketLib/shutdown.c index 4c00feade7..c3df1ee519 100644 --- a/StdLib/BsdSocketLib/shutdown.c +++ b/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. **/ diff --git a/StdLib/BsdSocketLib/socket.c b/StdLib/BsdSocketLib/socket.c index 3754a29eb0..e78329291c 100644 --- a/StdLib/BsdSocketLib/socket.c +++ b/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 (
  • IPPROTO_UDP
    • - This value must be combined with SOCK_DGRAM. - @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. **/ diff --git a/StdLib/BsdSocketLib/write.c b/StdLib/BsdSocketLib/write.c index d04dda9c39..f6f50006af 100644 --- a/StdLib/BsdSocketLib/write.c +++ b/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 diff --git a/StdLib/Include/Protocol/EfiSocket.h b/StdLib/Include/Protocol/EfiSocket.h index 5e044fac9e..e9e4604048 100644 --- 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. @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. **/ diff --git a/StdLib/Include/wchar.h b/StdLib/Include/wchar.h index c42594787d..bab02b05b9 100644 --- a/StdLib/Include/wchar.h +++ b/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); diff --git a/StdLib/LibC/Uefi/SysCalls.c b/StdLib/LibC/Uefi/SysCalls.c index d2fb0c6af6..d52249b58b 100644 --- a/StdLib/LibC/Uefi/SysCalls.c +++ b/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 - working directory in the array pointed to by buf, and return buf. The - pathname copied to the array shall contain no components that are - symbolic links. The size argument is the size in bytes of the character - array pointed to by the buf argument. - + The getcwd() function shall place an absolute pathname of the current + working directory in the array pointed to by buf, and return buf. The + pathname copied to the array shall contain no components that are + symbolic links. The size argument is the size in bytes of the character + 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 -*getcwd (char *buf, size_t size) +char +*getcwd (char *buf, size_t size) { CONST CHAR16 *Cwd; @@ -1133,7 +1133,7 @@ char errno = ERANGE; return (NULL); } - + return (UnicodeStrToAsciiStr(Cwd, buf)); } -- cgit v1.2.3