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

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

8
StdLib/BsdSocketLib/connect.c
View File

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

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

6
StdLib/BsdSocketLib/recv.c
View File

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

4
StdLib/BsdSocketLib/recvfrom.c
View File

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

4
StdLib/BsdSocketLib/send.c
View File

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

4
StdLib/BsdSocketLib/sendto.c
View File

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

4
StdLib/BsdSocketLib/shutdown.c
View File

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

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

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