Add comments for functions and fix some coding style issue.

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

diff --git a/MdePkg/Include/Protocol/Decompress.h b/MdePkg/Include/Protocol/Decompress.h
index 0cc9bb7e36f070b9eba1eab2caa14857dc73e990..ed1e4220e1c2a6df74ac5cb928e16d542e70c275 100644 (file)
--- a/MdePkg/Include/Protocol/Decompress.h
+++ b/MdePkg/Include/Protocol/Decompress.h
@@ -38,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
@@ -79,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
@@ -109,22 +109,9 @@ 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
+///\r
+/// Provides a decompression service.\r
+///\r
 struct _EFI_DECOMPRESS_PROTOCOL {\r
   EFI_DECOMPRESS_GET_INFO   GetInfo;\r
   EFI_DECOMPRESS_DECOMPRESS Decompress;\r