MdePkg: Refine the function comments in Keyword Handler Protocol

Refine the function comments in HiiConfigKeyword.h.

Cc: Liming Gao <liming.gao@intel.com>
Cc: Eric Dong <eric.dong@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Dandan Bi <dandan.bi@intel.com>
Reviewed-by: Eric Dong <eric.dong@intel.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>
This commit is contained in:
Dandan Bi 2016-02-15 14:39:11 +08:00 committed by Star Zeng
parent 91af324da0
commit 38baa5b619

View File

@ -3,7 +3,7 @@
associated with a keyword exposed through a x-UEFI- prefixed associated with a keyword exposed through a x-UEFI- prefixed
configuration language namespace. 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 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 terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at The full text of the license may be found at
@ -64,8 +64,9 @@ typedef struct _EFI_CONFIG_KEYWORD_HANDLER_PROTOCOL EFI_CONFIG_KEYWORD_HANDLER_P
@param Progress On return, points to a character in the KeywordString. @param Progress On return, points to a character in the KeywordString.
Points to the string's NULL terminator if the request Points to the string's NULL terminator if the request
was successful. Points to the most recent '&' before was successful. Points to the most recent '&' before
the first failing string element if the request was the first failing name / value pair (or the beginning
not successful. 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 @param ProgressErr If during the processing of the KeywordString there was
a failure, this parameter gives additional information a failure, this parameter gives additional information
@ -134,8 +135,9 @@ EFI_STATUS
@param Progress On return, points to a character in the KeywordString. Points @param Progress On return, points to a character in the KeywordString. Points
to the string's NULL terminator if the request was successful. to the string's NULL terminator if the request was successful.
Points to the most recent '&' before the first failing string Points to the most recent '&' before the first failing name / value
element if the request was not successful. 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 @param ProgressErr If during the processing of the KeywordString there was a
failure, this parameter gives additional information about the failure, this parameter gives additional information about the