Update the sockets library code

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

diff --git a/StdLib/BsdSocketLib/getsockopt.c b/StdLib/BsdSocketLib/getsockopt.c
index eac10544de15ed3675c84f6730cb6c902ae88356..47b7c6fb34eab3f6160cb7151fed02b3916a7049 100644 (file)
--- a/StdLib/BsdSocketLib/getsockopt.c
+++ b/StdLib/BsdSocketLib/getsockopt.c
@@ -18,6 +18,10 @@
 /**\r
   Get the socket options\r
 \r
+  The\r
+  <a href="http://pubs.opengroup.org/onlinepubs/9699919799/functions/getsockopt.html#">POSIX</a>\r
+  documentation is available online.\r
+\r
   @param [in] s               Socket file descriptor returned from ::socket.\r
   @param [in] level           Option protocol level\r
   @param [in] option_name     Name of the option\r
@@ -25,8 +29,8 @@
   @param [in,out] option_len  Length of the buffer in bytes,\r
                               upon return length of the option value in bytes\r
 \r
-  @retval   Zero (0) upon success\r
-  @retval   Minus one (-1) upon failure, errno set with additional error information\r
+  @return     This routine returns zero (0) if successful or -1 when an error occurs.\r
+              In the case of an error, ::errno contains more details.\r
 \r
 **/\r
 int\r