sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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

Browse Source 
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@12094 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
darylm503
2011-08-05 23:57:34 +00:00
parent 59d13433e7
commit 7dc1329100
24 changed files with 5092 additions and 5092 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
StdLib/Include/Protocol/EfiSocket.h
View File

@@ -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.
**/

6
StdLib/Include/wchar.h
View File

@@ -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);