Code scrub for the Debug library, PostCode library, Print library, and ExtractGuidedS...

[mirror_edk2.git] / MdePkg / Include / Library / UefiDecompressLib.h

diff --git a/MdePkg/Include/Library/UefiDecompressLib.h b/MdePkg/Include/Library/UefiDecompressLib.h
index afedf307b59b64acc837a2c97347c006ee406fe0..2af91de2739a9f3908f271cd52d68f39856c7a66 100644 (file)
--- a/MdePkg/Include/Library/UefiDecompressLib.h
+++ b/MdePkg/Include/Library/UefiDecompressLib.h
@@ -1,7 +1,12 @@
 /** @file\r
-  Return UEFI Decompress Protocol \r
+  UEFI Decompress Library Functions defintion\r
 \r
-  Copyright (c) 2006, Intel Corporation                                                         \r
+  The UEFI Decompress Library enables the decompression of objects that \r
+  were compressed using the UEFI compression scheme. The UEFI Decompress \r
+  Library is independent of environment and requires the caller to allocate \r
+  all required memory buffers.\r
+\r
+  Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
   All rights reserved. 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
@@ -16,7 +21,9 @@
 #define __UEFI_DECPOMPRESS_LIB_H__\r
 \r
 /**\r
-  Retrieves the size of the uncompressed buffer and the size of the scratch buffer.\r
+  Given a compressed source buffer, this function retrieves the size of \r
+  the uncompressed buffer and the size of the scratch buffer required \r
+  to decompress the compressed source buffer.\r
 \r
   Retrieves the size of the uncompressed buffer and the temporary scratch buffer \r
   required to decompress the buffer specified by Source and SourceSize.\r
@@ -43,10 +50,14 @@
                           is required to decompress the compressed buffer specified \r
                           by Source and SourceSize.\r
 \r
-  @retval  RETURN_SUCCESS The size of destination buffer and the size of scratch \r
-                          buffer are successull retrieved.\r
-  @retval  RETURN_INVALID_PARAMETER The source data is corrupted\r
-\r
+  @retval  RETURN_SUCCESS The size of the uncompressed data was returned \r
+                          in DestinationSize and the size of the scratch \r
+                          buffer was returned in ScratchSize.\r
+  @retval  RETURN_INVALID_PARAMETER \r
+                          The size of the uncompressed data or the size of \r
+                          the scratch buffer cannot be determined from \r
+                          the compressed data specified by Source \r
+                          and SourceSize.\r
 **/\r
 RETURN_STATUS\r
 EFIAPI\r
@@ -60,6 +71,7 @@ UefiDecompressGetInfo (
 /**\r
   Decompresses a compressed source buffer.\r
 \r
+  Extracts decompressed data to its original form.\r
   This function is designed so that the decompression algorithm can be implemented\r
   without using any memory services.  As a result, this function is not allowed to\r
   call any memory allocation services in its implementation.  It is the caller's r\r
@@ -79,9 +91,11 @@ UefiDecompressGetInfo (
                       This is an optional parameter that may be NULL if the \r
                       required scratch buffer size is 0.\r
                      \r
-  @retval  RETURN_SUCCESS Decompression is successfull\r
-  @retval  RETURN_INVALID_PARAMETER The source data is corrupted\r
-\r
+  @retval  RETURN_SUCCESS Decompression completed successfully, and \r
+                          the uncompressed buffer is returned in Destination.\r
+  @retval  RETURN_INVALID_PARAMETER \r
+                          The source buffer specified by Source is corrupted \r
+                          (not in a valid compressed format).\r
 **/\r
 RETURN_STATUS\r
 EFIAPI\r