From 070a76b19386875d96f945262e832183d61f43da Mon Sep 17 00:00:00 2001 From: klu2 Date: Wed, 10 Dec 2008 03:28:54 +0000 Subject: Synchronize interface function comment from declaration in library class header file to implementation in library instance. git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6957 6f19259b-4bc3-4df7-8a09-765794883524 --- MdePkg/Library/UefiMemoryLib/CompareMemWrapper.c | 4 ++-- MdePkg/Library/UefiMemoryLib/MemLibInternals.h | 30 ++++++++++++++---------- 2 files changed, 19 insertions(+), 15 deletions(-) (limited to 'MdePkg/Library/UefiMemoryLib') diff --git a/MdePkg/Library/UefiMemoryLib/CompareMemWrapper.c b/MdePkg/Library/UefiMemoryLib/CompareMemWrapper.c index 641259d507..27da96d56b 100644 --- a/MdePkg/Library/UefiMemoryLib/CompareMemWrapper.c +++ b/MdePkg/Library/UefiMemoryLib/CompareMemWrapper.c @@ -31,7 +31,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. If all Length bytes of the two buffers are identical, then 0 is returned. Otherwise, the value returned is the first mismatched byte in SourceBuffer subtracted from the first mismatched byte in DestinationBuffer. - + If Length > 0 and DestinationBuffer is NULL, then ASSERT(). If Length > 0 and SourceBuffer is NULL, then ASSERT(). If Length is greater than (MAX_ADDRESS - DestinationBuffer + 1), then ASSERT(). @@ -44,7 +44,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @return 0 All Length bytes of the two buffers are identical. @retval Non-zero The first mismatched byte in SourceBuffer subtracted from the first mismatched byte in DestinationBuffer. - + **/ INTN EFIAPI diff --git a/MdePkg/Library/UefiMemoryLib/MemLibInternals.h b/MdePkg/Library/UefiMemoryLib/MemLibInternals.h index 27c3c71851..4f3a7f700e 100644 --- a/MdePkg/Library/UefiMemoryLib/MemLibInternals.h +++ b/MdePkg/Library/UefiMemoryLib/MemLibInternals.h @@ -36,38 +36,42 @@ #include /** - Copy Length bytes from Source to Destination. + Copies a source buffer to a destination buffer, and returns the destination buffer. - @param DestinationBuffer Target of copy - @param SourceBuffer Place to copy from - @param Length Number of bytes to copy + This function wraps the gBS->CopyMem(). - @return Destination + @param DestinationBuffer Pointer to the destination buffer of the memory copy. + @param SourceBuffer Pointer to the source buffer of the memory copy. + @param Length Number of bytes to copy from SourceBuffer to DestinationBuffer. + + @return DestinationBuffer. **/ VOID * EFIAPI InternalMemCopyMem ( - OUT VOID *DestinationBuffer, - IN CONST VOID *SourceBuffer, + OUT VOID *Destination, + IN CONST VOID *Source, IN UINTN Length ); /** - Set Buffer to Value for Size bytes. + Fills a target buffer with a byte value, and returns the target buffer. - @param Buffer Memory to set. - @param Length Number of bytes to set - @param Value Value of the set operation. + This function wraps the gBS->SetMem(). - @return Buffer + @param Buffer Memory to set. + @param Size Number of bytes to set. + @param Value Value of the set operation. + + @return Buffer. **/ VOID * EFIAPI InternalMemSetMem ( OUT VOID *Buffer, - IN UINTN Length, + IN UINTN Size, IN UINT8 Value ); -- cgit v1.2.3