Update the sockets library code

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

diff --git a/StdLib/BsdSocketLib/setsockopt.c b/StdLib/BsdSocketLib/setsockopt.c
index 74c948c783b61387c1aeb56c0a80865bbd298163..64f3a359111fbc8cb7e9aec8316a229b699b7c7d 100644 (file)
--- a/StdLib/BsdSocketLib/setsockopt.c
+++ b/StdLib/BsdSocketLib/setsockopt.c
@@ -18,14 +18,18 @@
 /**\r
   Set the socket options\r
 \r
+  The\r
+  <a href="http://pubs.opengroup.org/onlinepubs/9699919799/functions/setsockopt.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
   @param [in] option_value    Buffer containing the option value\r
   @param [in] option_len      Length of the 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) upon success and -1 when an error occurs.\r
+            In the case of an error, ::errno contains more details.\r
 \r
 **/\r
 int\r