code scrub ArpDxe

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

diff --git a/MdePkg/Include/Protocol/Decompress.h b/MdePkg/Include/Protocol/Decompress.h
index 7c295f310ee8e7b18d048f624c76dc06ca30b8c0..ed1e4220e1c2a6df74ac5cb928e16d542e70c275 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
@@ -10,8 +10,6 @@
   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
 \r
-  Module Name:  Decompress.h\r
-\r
 **/\r
 \r
 #ifndef __DECOMPRESS_H__\r
@@ -40,7 +38,7 @@ typedef struct _EFI_DECOMPRESS_PROTOCOL  EFI_DECOMPRESS_PROTOCOL;
   output it as DestinationSize.  And ScratchSize is specific to the decompression\r
   implementation.\r
 \r
-  @param  This            The protocol instance pointer\r
+  @param  This            A pointer to the EFI_DECOMPRESS_PROTOCOL instance.\r
   @param  Source          The source buffer containing the compressed data.\r
   @param  SourceSize      The size, in bytes, of source buffer.\r
   @param  DestinationSize A pointer to the size, in bytes, of the uncompressed buffer\r
@@ -59,7 +57,7 @@ typedef struct _EFI_DECOMPRESS_PROTOCOL  EFI_DECOMPRESS_PROTOCOL;
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_DECOMPRESS_GET_INFO) (\r
+(EFIAPI *EFI_DECOMPRESS_GET_INFO)(\r
   IN EFI_DECOMPRESS_PROTOCOL            *This,\r
   IN   VOID                             *Source,\r
   IN   UINT32                           SourceSize,\r
@@ -81,7 +79,7 @@ EFI_STATUS
   If the compressed source data specified by Source and SourceSize is not in \r
   a valid compressed data format, then EFI_INVALID_PARAMETER is returned.\r
 \r
-  @param  This            The protocol instance pointer\r
+  @param  This            A pointer to the EFI_DECOMPRESS_PROTOCOL instance.\r
   @param  Source          The source buffer containing the compressed data.\r
   @param  SourceSize      The size of source data.\r
   @param  Destination     On output, the destination buffer that contains\r
@@ -101,7 +99,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_DECOMPRESS_DECOMPRESS) (\r
+(EFIAPI *EFI_DECOMPRESS_DECOMPRESS)(\r
   IN EFI_DECOMPRESS_PROTOCOL              *This,\r
   IN     VOID                             *Source,\r
   IN     UINT32                           SourceSize,\r
@@ -111,6 +109,9 @@ EFI_STATUS
   IN     UINT32                           ScratchSize\r
   );\r
 \r
+///\r
+/// Provides a decompression service.\r
+///\r
 struct _EFI_DECOMPRESS_PROTOCOL {\r
   EFI_DECOMPRESS_GET_INFO   GetInfo;\r
   EFI_DECOMPRESS_DECOMPRESS Decompress;\r