From 630b41877e9a1afe59d4f8a1c22bc691fe933ff8 Mon Sep 17 00:00:00 2001 From: pkandel Date: Thu, 4 Jun 2009 05:49:29 +0000 Subject: Reviewed the code comments in the Include/Protocol directory for typos, grammar issues, and language clarity. git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8462 6f19259b-4bc3-4df7-8a09-765794883524 --- MdePkg/Include/Protocol/HiiConfigRouting.h | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) (limited to 'MdePkg/Include/Protocol/HiiConfigRouting.h') diff --git a/MdePkg/Include/Protocol/HiiConfigRouting.h b/MdePkg/Include/Protocol/HiiConfigRouting.h index 8e833bdede..1530bb824c 100644 --- a/MdePkg/Include/Protocol/HiiConfigRouting.h +++ b/MdePkg/Include/Protocol/HiiConfigRouting.h @@ -87,8 +87,9 @@ typedef struct _EFI_HII_CONFIG_ROUTING_PROTOCOL EFI_HII_CONFIG_ROUTING_PROTOCOL; for the Request parameter would result in this type of error. The Progress parameter - is set to NULL. EFI_NOT_FOUND - Routing data doesn't match any + is set to NULL. + + @retval EFI_NOT_FOUND Routing data doesn't match any known driver. Progress set to the "G" in "GUID" of the routing header that doesn't @@ -256,8 +257,8 @@ EFI_STATUS @retval EFI_NOT_FOUND Target for the specified routing data was not found. Progress points to the 'G' in "GUID" of the errant routing - data. EFI_DEVICE_ERROR Block not large - enough. Progress undefined. + data. + @retval EFI_DEVICE_ERROR Block not large enough. Progress undefined. @retval EFI_INVALID_PARAMETER Encountered non formatted string. Block is @@ -324,7 +325,7 @@ EFI_STATUS @retval EFI_SUCCESS The request succeeded. Progress points to the null terminator at the end of the ConfigResp string. - @retval EFI_OUT_OF_RESOURCES Not enough memory to allocate Config. Progress + @retval EFI_OUT_OF_RESOURCES Not enough memory to allocate Config. Progress points to the first character of ConfigResp. @retval EFI_INVALID_PARAMETER Passing in a NULL for the ConfigResp or Block parameter would result in this type of -- cgit v1.2.3