diff options
| author | Jaben Carsey <jaben.carsey@intel.com> | 2018-10-30 17:47:48 -0700 |
|---|---|---|
| committer | Jaben Carsey <jaben.carsey@intel.com> | 2019-01-10 08:22:29 -0800 |
| commit | a653a525515698d80cbecc1ca3d0e8f48e7390a2 (patch) | |
| tree | 2caa1a39b0b37b15062192bc120f1d6e9c81d688 /MdeModulePkg/Library/BaseSortLib | |
| parent | 15666b8cd0a27dcc9ab062b8004ddf3ed7d4e7f4 (diff) | |
| download | edk2-a653a525515698d80cbecc1ca3d0e8f48e7390a2.tar.gz edk2-a653a525515698d80cbecc1ca3d0e8f48e7390a2.tar.bz2 edk2-a653a525515698d80cbecc1ca3d0e8f48e7390a2.zip | |
MdeModulePkg: fix comments in BaseSortLib
The comments are incorrect for the base version of this lib.
Reviewed-by: Star Zeng <star.zeng@intel.com>
Reviewed-by: Jian J Wang <jian.j.wang@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Jaben Carsey <jaben.carsey@intel.com>
Cc: Star Zeng <star.zeng@intel.com>
Cc: Jian J Wang <jian.j.wang@intel.com>
Diffstat (limited to 'MdeModulePkg/Library/BaseSortLib')
| -rw-r--r-- | MdeModulePkg/Library/BaseSortLib/BaseSortLib.c | 22 |
1 files changed, 9 insertions, 13 deletions
diff --git a/MdeModulePkg/Library/BaseSortLib/BaseSortLib.c b/MdeModulePkg/Library/BaseSortLib/BaseSortLib.c index ab8a60585e..8f30c00971 100644 --- a/MdeModulePkg/Library/BaseSortLib/BaseSortLib.c +++ b/MdeModulePkg/Library/BaseSortLib/BaseSortLib.c @@ -1,7 +1,7 @@ /** @file
Library used for sorting routines.
- Copyright (c) 2009 - 2014, Intel Corporation. All rights reserved. <BR>
+ Copyright (c) 2009 - 2018, 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
@@ -193,14 +193,12 @@ DevicePathCompare ( }
/**
- Function to compare 2 strings without regard to case of the characters.
+ Not supported in Base version.
- @param[in] Buffer1 Pointer to String to compare.
- @param[in] Buffer2 Pointer to second String to compare.
+ @param[in] Buffer1 Ignored.
+ @param[in] Buffer2 Ignored.
- @retval 0 Buffer1 equal to Buffer2.
- @return < 0 Buffer1 is less than Buffer2.
- @return > 0 Buffer1 is greater than Buffer2.
+ ASSERT and return 0.
**/
INTN
EFIAPI
@@ -215,14 +213,12 @@ StringNoCaseCompare ( /**
- Function to compare 2 strings.
+ Not supported in Base version.
- @param[in] Buffer1 Pointer to String to compare (CHAR16**).
- @param[in] Buffer2 Pointer to second String to compare (CHAR16**).
+ @param[in] Buffer1 Ignored.
+ @param[in] Buffer2 Ignored.
- @retval 0 Buffer1 equal to Buffer2.
- @return < 0 Buffer1 is less than Buffer2.
- @return > 0 Buffer1 is greater than Buffer2.
+ ASSERT and return 0.
**/
INTN
EFIAPI
|