Code Scrub for Protocol and Ppi Definition

[mirror_edk2.git] / MdePkg / Include / Protocol / Decompress.h

diff --git a/MdePkg/Include/Protocol/Decompress.h b/MdePkg/Include/Protocol/Decompress.h
index 83d59a3dcdc98e5348b5818f472eaedcd3a7a8ca..0cc9bb7e36f070b9eba1eab2caa14857dc73e990 100644 (file)
--- a/MdePkg/Include/Protocol/Decompress.h
+++ b/MdePkg/Include/Protocol/Decompress.h
@@ -1,7 +1,7 @@
 /** @file\r
-  The Decompress Protocol Interface\r
+  The Decompress Protocol Interface as defined in UEFI spec\r
 \r
-  Copyright (c) 2006, Intel Corporation                                                         \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
@@ -109,6 +109,22 @@ EFI_STATUS
   IN     UINT32                           ScratchSize\r
   );\r
 \r
+/**\r
+  @par Protocol Description:\r
+  Provides a decompression service.\r
+\r
+  @param GetInfo\r
+  Given the compressed source buffer, this function retrieves the\r
+  size of the uncompressed destination buffer and the size of the\r
+  scratch buffer required to perform the decompression. It is the\r
+  caller's responsibility to allocate the destination buffer and the\r
+  scratch buffer prior to calling EFI_DECOMPRESS_PROTOCOL.Decompress().\r
+\r
+  @param Decompresss\r
+  Decompresses a compressed source buffer into an uncompressed\r
+  destination buffer. It is the caller's responsibility to allocate the\r
+  destination buffer and a scratch buffer prior to making this call.\r
+**/ \r
 struct _EFI_DECOMPRESS_PROTOCOL {\r
   EFI_DECOMPRESS_GET_INFO   GetInfo;\r
   EFI_DECOMPRESS_DECOMPRESS Decompress;\r