Clarify @pram b in Base.h. Accepted and edited in Qing Huang changes for @retval...
authormyronporter <myronporter@6f19259b-4bc3-4df7-8a09-765794883524>
Mon, 15 Mar 2010 17:28:58 +0000 (17:28 +0000)
committermyronporter <myronporter@6f19259b-4bc3-4df7-8a09-765794883524>
Mon, 15 Mar 2010 17:28:58 +0000 (17:28 +0000)
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10248 6f19259b-4bc3-4df7-8a09-765794883524

MdePkg/Include/Base.h
MdePkg/Include/Protocol/Udp4.h

index 5eabb80eff4841d6dcb34437ba00f969477ef527..5b1f418d1af4d9c9c0d356d718584c0119751e0f 100644 (file)
@@ -636,7 +636,8 @@ typedef UINTN  *BASE_LIST;
   Both a and b must be the same numerical types, signed or unsigned.\r
 \r
   @param   a        The first operand with any numerical type.\r
   Both a and b must be the same numerical types, signed or unsigned.\r
 \r
   @param   a        The first operand with any numerical type.\r
-  @param   b        The second operand. It should be the same any numerical type with a.\r
+  @param   b        The second operand. Can be any numerical type as long as is \r
+                    the same type as a.\r
   \r
   @return  Maximum of two operands.\r
   \r
   \r
   @return  Maximum of two operands.\r
   \r
index f1738163275b0a136651fdd9249b1b9f3110085c..5541f5e692ae716b7323ad09f55efce6dc4bcc61 100644 (file)
@@ -168,7 +168,8 @@ EFI_STATUS
   @retval EFI_SUCCESS           The configuration settings were set, changed, or reset successfully.\r
   @retval EFI_NO_MAPPING        When using a default address, configuration (DHCP, BOOTP,\r
                                 RARP, etc.) is not finished yet.\r
   @retval EFI_SUCCESS           The configuration settings were set, changed, or reset successfully.\r
   @retval EFI_NO_MAPPING        When using a default address, configuration (DHCP, BOOTP,\r
                                 RARP, etc.) is not finished yet.\r
-  @retval EFI_INVALID_PARAMETER One or more following conditions are TRUE:\r
+  @retval EFI_INVALID_PARAMETER This is NULL.\r
+  @retval EFI_INVALID_PARAMETER UdpConfigData.StationAddress is not a valid unicast IPv4 address.\r
   @retval EFI_ALREADY_STARTED   The EFI UDPv4 Protocol instance is already started/configured\r
                                 and must be stopped/reset before it can be reconfigured.\r
   @retval EFI_ACCESS_DENIED     UdpConfigData. AllowDuplicatePort is FALSE\r
   @retval EFI_ALREADY_STARTED   The EFI UDPv4 Protocol instance is already started/configured\r
                                 and must be stopped/reset before it can be reconfigured.\r
   @retval EFI_ACCESS_DENIED     UdpConfigData. AllowDuplicatePort is FALSE\r
@@ -318,7 +319,8 @@ EFI_STATUS
   @retval EFI_NOT_STARTED       This EFI UDPv4 Protocol instance has not been started.\r
   @retval EFI_NO_MAPPING        When using a default address, configuration (DHCP, BOOTP, RARP, etc.)\r
                                 is not finished yet.\r
   @retval EFI_NOT_STARTED       This EFI UDPv4 Protocol instance has not been started.\r
   @retval EFI_NO_MAPPING        When using a default address, configuration (DHCP, BOOTP, RARP, etc.)\r
                                 is not finished yet.\r
-  @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
+  @retval EFI_INVALID_PARAMETER This is NULL.\r
+  @retval EFI_INVALID_PARAMETER UdpConfigData.StationAddress is not a valid unicast IPv4 address.\r
   @retval EFI_OUT_OF_RESOURCES  The receive completion token could not be queued due to a lack of system\r
                                 resources (usually memory).\r
   @retval EFI_DEVICE_ERROR      An unexpected system or network error occurred.\r
   @retval EFI_OUT_OF_RESOURCES  The receive completion token could not be queued due to a lack of system\r
                                 resources (usually memory).\r
   @retval EFI_DEVICE_ERROR      An unexpected system or network error occurred.\r