Refine the function comments in HiiConfigKeyword.h. Cc: Liming Gao <liming....@intel.com> Cc: Eric Dong <eric.d...@intel.com> Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Dandan Bi <dandan...@intel.com> Reviewed-by: Eric Dong <eric.d...@intel.com> --- MdePkg/Include/Protocol/HiiConfigKeyword.h | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-)
diff --git a/MdePkg/Include/Protocol/HiiConfigKeyword.h b/MdePkg/Include/Protocol/HiiConfigKeyword.h index f8fe192..69280b8 100644 --- a/MdePkg/Include/Protocol/HiiConfigKeyword.h +++ b/MdePkg/Include/Protocol/HiiConfigKeyword.h @@ -1,11 +1,11 @@ /** @file The file provides the mechanism to set and get the values associated with a keyword exposed through a x-UEFI- prefixed configuration language namespace. -Copyright (c) 2015, Intel Corporation. All rights reserved.<BR> +Copyright (c) 2015 - 2016, Intel Corporation. All rights reserved.<BR> This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php. @@ -62,12 +62,13 @@ typedef struct _EFI_CONFIG_KEYWORD_HANDLER_PROTOCOL EFI_CONFIG_KEYWORD_HANDLER_P @param KeywordString A null-terminated string in <MultiKeywordResp> format. @param Progress On return, points to a character in the KeywordString. Points to the string's NULL terminator if the request was successful. Points to the most recent '&' before - the first failing string element if the request was - not successful. + the first failing name / value pair (or the beginning + of the string if the failure is in the first name / value + pair) if the request was not successful. @param ProgressErr If during the processing of the KeywordString there was a failure, this parameter gives additional information about the possible source of the problem. The various errors are defined in "Related Definitions" below. @@ -132,12 +133,13 @@ EFI_STATUS keywords in the system for the NameSpaceId specified are returned in the Results field. @param Progress On return, points to a character in the KeywordString. Points to the string's NULL terminator if the request was successful. - Points to the most recent '&' before the first failing string - element if the request was not successful. + Points to the most recent '&' before the first failing name / value + pair (or the beginning of the string if the failure is in the first + name / value pair) if the request was not successful. @param ProgressErr If during the processing of the KeywordString there was a failure, this parameter gives additional information about the possible source of the problem. See the definitions in SetData() for valid value definitions. -- 1.9.5.msysgit.1 _______________________________________________ edk2-devel mailing list edk2-devel@lists.01.org https://lists.01.org/mailman/listinfo/edk2-devel
