MdeModulePkg: Add DriverHealthManagerDxe driver.

[mirror_edk2.git] / StdLib / BsdSocketLib / recvfrom.c

diff --git a/StdLib/BsdSocketLib/recvfrom.c b/StdLib/BsdSocketLib/recvfrom.c
index a8d1ab54eef45a94cb16cabea78e941280261920..20b3f4a9164c9cc199ff0bcfe7d5f426122c0280 100644 (file)
--- a/StdLib/BsdSocketLib/recvfrom.c
+++ b/StdLib/BsdSocketLib/recvfrom.c
@@ -18,15 +18,19 @@
 /**\r
   Receive data from a network connection and return the remote system's address.\r
 \r
-  The ::recvfrom routine waits for receive data from a remote network\r
-  connection.  The\r
+  The recvfrom routine waits for receive data from a remote network\r
+  connection.  This routine is typically called for SOCK_DGRAM sockets\r
+  when the socket is being shared by multiple remote systems and it is\r
+  important to get the remote system address for a response.\r
+\r
+  The\r
   <a href="http://pubs.opengroup.org/onlinepubs/9699919799/functions/recv.html">POSIX</a>\r
   documentation is available online.\r
 \r
   @param [in] s         Socket file descriptor returned from ::socket.\r
 \r
   @param [in] buffer    Address of a buffer to receive the data.\r
-  \r
+\r
   @param [in] length    Length of the buffer in bytes.\r
 \r
   @param [in] flags     Message control flags\r
@@ -35,9 +39,9 @@
 \r
   @param [in] address_len Length of the remote network address structure\r
 \r
-  @returns    ::recvfrom returns the number of valid bytes in the buffer,\r
+  @return     This routine returns the number of valid bytes in the buffer,\r
               zero if no data was received, and -1 when an error occurs.\r
-              In the case of an error, errno contains more details.\r
+              In the case of an error, ::errno contains more details.\r
 \r
  **/\r
 ssize_t\r