tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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
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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
AppPkg/Applications/Sockets/DataSource/DataSource.c
View File

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

6
AppPkg/Applications/Sockets/TftpServer/TftpServer.c
View File

@ -351,7 +351,7 @@ SocketPoll (
@param [in] Character The character to convert
@returns The lower case equivalent of the character
@return The lower case equivalent of the character
**/
int
@ -382,7 +382,7 @@ tolower (
@param [in] pString1 Zero terminated string address
@param [in] pString2 Zero terminated string address
@returns Returns the first character difference between string 1
@return Returns the first character difference between string 1
and string 2.
**/
@ -501,7 +501,7 @@ TftpOptionGet (
@param [in] pOack Option acknowledgement address
@param [in] Value Value to translate into ASCII decimal
@returns Option acknowledgement address
@return Option acknowledgement address
**/
UINT8 *

6
AppPkg/Applications/Sockets/WebServer/ACPI.c
View File

@ -155,7 +155,7 @@ CONST TABLE_SIGNATURE mTableId [] = {
/**
Locate the RSDT table
@returns Table address or NULL if not found
@return Table address or NULL if not found
**/
CONST ACPI_RSDT *
@ -202,7 +202,7 @@ LocateRsdt (
@param [in] Signature Table signature
@returns Table address or NULL if not found
@return Table address or NULL if not found
**/
CONST VOID *
@ -767,7 +767,7 @@ RowGenericAddress (
@param [in] pSignature Address of the table signature
@param [out] ppTableName Address to receive the table name address
@returns Zero terminated web page address or NULL if not found
@return Zero terminated web page address or NULL if not found
**/
CONST CHAR16 *

8
AppPkg/Applications/Sockets/WebServer/HTTP.c
View File

@ -31,7 +31,7 @@ Intel Corporation.
@param [in] pData The address of the buffer containing the character
@param [out] ppData The address to receive the next character address
@returns The character value
@return The character value
**/
INTN
@ -157,7 +157,7 @@ HttpFlush (
@param [in] Character The character to convert to lower case.
@returns The lower case character
@return The lower case character
**/
INTN
@ -186,7 +186,7 @@ HttpLowerCase (
@param [in] pData A zero terminated UTF-8 string
@param [in] bIgnoreCase TRUE if case is to be ignored
@returns The difference between the last two characters tested.
@return The difference between the last two characters tested.
Returns -1 for error.
**/
@ -486,7 +486,7 @@ HttpPageTrailer (
@param [in] pData The request buffer address
@param [in] pEnd End of buffer address
@returns The next character location
@return The next character location
**/
UINT8 *

14
StdLib/BsdSocketLib/SocketInternals.h
View File

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

6
StdLib/BsdSocketLib/accept.c
View File

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

8
StdLib/BsdSocketLib/bind.c
View File

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

8
StdLib/BsdSocketLib/close.c
View File

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

2
StdLib/BsdSocketLib/connect.c
View File

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

2
StdLib/BsdSocketLib/getpeername.c
View File

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

2
StdLib/BsdSocketLib/getsockname.c
View File

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

2
StdLib/BsdSocketLib/listen.c
View File

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

2
StdLib/BsdSocketLib/poll.c
View File

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

2
StdLib/BsdSocketLib/read.c
View File

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

2
StdLib/BsdSocketLib/recv.c
View File

@ -31,7 +31,7 @@
@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.

2
StdLib/BsdSocketLib/recvfrom.c
View File

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

2
StdLib/BsdSocketLib/send.c
View File

@ -31,7 +31,7 @@
@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.

2
StdLib/BsdSocketLib/sendto.c
View File

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

2
StdLib/BsdSocketLib/shutdown.c
View File

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

8
StdLib/BsdSocketLib/socket.c
View File

@ -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.
**/
@ -104,7 +104,7 @@ BslFdToSocketProtocol (
@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.
**/

2
StdLib/BsdSocketLib/write.c
View File

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

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

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

2
StdLib/LibC/Uefi/SysCalls.c
View File

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