diff options
| author | Dandan Bi <dandan.bi@intel.com> | 2016-02-15 14:39:11 +0800 |
|---|---|---|
| committer | Star Zeng <star.zeng@intel.com> | 2016-02-16 17:56:11 +0800 |
| commit | 38baa5b619efa54e20049b65440c70b69151aa23 (patch) | |
| tree | 786a9a0bcabd210b5f124e87ad55cc429325bd04 /MdePkg/Include/Protocol | |
| parent | 91af324da0a2fad4d09ac4024570b0ef2dd77aaf (diff) | |
| download | edk2-38baa5b619efa54e20049b65440c70b69151aa23.tar.gz edk2-38baa5b619efa54e20049b65440c70b69151aa23.tar.bz2 edk2-38baa5b619efa54e20049b65440c70b69151aa23.zip | |
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>
Diffstat (limited to 'MdePkg/Include/Protocol')
| -rw-r--r-- | MdePkg/Include/Protocol/HiiConfigKeyword.h | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/MdePkg/Include/Protocol/HiiConfigKeyword.h b/MdePkg/Include/Protocol/HiiConfigKeyword.h index f8fe19282c..69280b88cc 100644 --- a/MdePkg/Include/Protocol/HiiConfigKeyword.h +++ b/MdePkg/Include/Protocol/HiiConfigKeyword.h @@ -3,7 +3,7 @@ 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
@@ -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.
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
@@ -134,8 +135,9 @@ EFI_STATUS @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
|