mirror of https://github.com/acidanthera/audk.git
MdeModulePkg: Refine function comments in Keyword Handler Protocol
Refine the function comments in ConfigKeywordHandler.c and HiiDatabase.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:
parent
fbf2338143
commit
91af324da0
|
@ -1,7 +1,7 @@
|
|||
/** @file
|
||||
Implementation of interfaces function for EFI_CONFIG_KEYWORD_HANDLER_PROTOCOL.
|
||||
|
||||
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
|
||||
which accompanies this distribution. The full text of the license may be found at
|
||||
|
@ -2754,8 +2754,9 @@ Done:
|
|||
@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
|
||||
|
@ -3032,8 +3033,9 @@ Done:
|
|||
|
||||
@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
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
/** @file
|
||||
Private structures definitions in HiiDatabase.
|
||||
|
||||
Copyright (c) 2007 - 2015, Intel Corporation. All rights reserved.<BR>
|
||||
Copyright (c) 2007 - 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
|
||||
which accompanies this distribution. The full text of the license may be found at
|
||||
|
@ -1858,8 +1858,9 @@ HiiGetAltCfg (
|
|||
@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
|
||||
|
@ -1927,8 +1928,9 @@ EfiConfigKeywordHandlerSetData (
|
|||
|
||||
@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
|
||||
|
|
Loading…
Reference in New Issue