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>

diff --git a/MdeModulePkg/Library/BaseSortLib/BaseSortLib.c b/MdeModulePkg/Library/BaseSortLib/BaseSortLib.c
index ab8a60585ee24849f96ccf2db098d0fd7b8e8ad0..8f30c00971ebfc22e289c957f278fc45a18de1c6 100644 (file)
--- a/MdeModulePkg/Library/BaseSortLib/BaseSortLib.c
+++ b/MdeModulePkg/Library/BaseSortLib/BaseSortLib.c
@@ -1,7 +1,7 @@
 /** @file\r
   Library used for sorting routines.\r
 \r
-  Copyright (c) 2009 - 2014, Intel Corporation. All rights reserved. <BR>\r
+  Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved. <BR>\r
   This program and the accompanying materials\r
   are licensed and made available under the terms and conditions of the BSD License\r
   which accompanies this distribution.  The full text of the license may be found at\r
@@ -193,14 +193,12 @@ DevicePathCompare (
 }\r
 \r
 /**\r
-  Function to compare 2 strings without regard to case of the characters.\r
+  Not supported in Base version.\r
 \r
-  @param[in] Buffer1            Pointer to String to compare.\r
-  @param[in] Buffer2            Pointer to second String to compare.\r
+  @param[in] Buffer1  Ignored.\r
+  @param[in] Buffer2  Ignored.\r
 \r
-  @retval 0                     Buffer1 equal to Buffer2.\r
-  @return < 0                   Buffer1 is less than Buffer2.\r
-  @return > 0                   Buffer1 is greater than Buffer2.\r
+  ASSERT and return 0.\r
 **/\r
 INTN\r
 EFIAPI\r
@@ -215,14 +213,12 @@ StringNoCaseCompare (
 \r
 \r
 /**\r
-  Function to compare 2 strings.\r
+  Not supported in Base version.\r
 \r
-  @param[in] Buffer1            Pointer to String to compare (CHAR16**).\r
-  @param[in] Buffer2            Pointer to second String to compare (CHAR16**).\r
+  @param[in] Buffer1  Ignored.\r
+  @param[in] Buffer2  Ignored.\r
 \r
-  @retval 0                     Buffer1 equal to Buffer2.\r
-  @return < 0                   Buffer1 is less than Buffer2.\r
-  @return > 0                   Buffer1 is greater than Buffer2.\r
+  ASSERT and return 0.\r
 **/\r
 INTN\r
 EFIAPI\r