diff options
| author | jcarsey <jcarsey@6f19259b-4bc3-4df7-8a09-765794883524> | 2009-11-20 18:21:03 +0000 |
|---|---|---|
| committer | jcarsey <jcarsey@6f19259b-4bc3-4df7-8a09-765794883524> | 2009-11-20 18:21:03 +0000 |
| commit | a31bd33cf8089c0b0219a41afb06cf9b462a0ee3 (patch) | |
| tree | 7ae46837d33cddebe9a075f13927eb85ea8602e3 /ShellPkg/Include/Library/SortLib.h | |
| parent | 23bb88ecb5087dff71e91f4f1c03cb698e37c4f1 (diff) | |
| download | edk2-platforms-a31bd33cf8089c0b0219a41afb06cf9b462a0ee3.tar.xz | |
comment repairs.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@9460 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'ShellPkg/Include/Library/SortLib.h')
| -rw-r--r-- | ShellPkg/Include/Library/SortLib.h | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/ShellPkg/Include/Library/SortLib.h b/ShellPkg/Include/Library/SortLib.h index 1345a52d59..2761994572 100644 --- a/ShellPkg/Include/Library/SortLib.h +++ b/ShellPkg/Include/Library/SortLib.h @@ -1,7 +1,7 @@ /** @file
Library used for sorting and comparison routines.
-Copyright (c) 2009, Intel Corporation
+Copyright (c) 2009, Intel Corporation<BR>
All rights reserved. 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
@@ -18,12 +18,12 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. /**
Prototype for comparison function for any 2 element types.
- @param[in] Buffer1 pointer to first buffer
- @param[in] Buffer2 pointer to second buffer
+ @param[in] Buffer1 Pointer to first buffer.
+ @param[in] Buffer2 Pointer to second buffer.
- @retval 0 Buffer1 equal to Buffer2
- @return < 0 Buffer1 is less than Buffer2
- @return > 0 Buffer1 is greater than Buffer2
+ @retval 0 Buffer1 equal to Buffer2.
+ @return < 0 Buffer1 is less than Buffer2.
+ @return > 0 Buffer1 is greater than Buffer2.
**/
typedef
INTN
@@ -37,18 +37,18 @@ INTN Each element must be equally sized.
- if BufferToSort is NULL, then ASSERT.
- if CompareFunction is NULL, then ASSERT.
+ If BufferToSort is NULL, then ASSERT.
+ If CompareFunction is NULL, then ASSERT.
- if Count is < 2 then perform no action.
- if Size is < 1 then perform no action.
+ If Count is < 2 then perform no action.
+ If Size is < 1 then perform no action.
- @param[in,out] BufferToSort on call a Buffer of (possibly sorted) elements
- on return a buffer of sorted elements
- @param[in] Count the number of elements in the buffer to sort
- @param[in] ElementSize Size of an element in bytes
+ @param[in,out] BufferToSort On call a Buffer of (possibly sorted) elements
+ on return a buffer of sorted elements.
+ @param[in] Count The number of elements in the buffer to sort
+ @param[in] ElementSize Size of an element in bytes.
@param[in] CompareFunction The function to call to perform the comparison
- of any 2 elements
+ of any 2 elements.
**/
VOID
EFIAPI
|