diff options
Diffstat (limited to 'MdePkg/Library/BaseCustomDecompressLibNull/BaseCustomDecompressLibNull.c')
| -rw-r--r-- | MdePkg/Library/BaseCustomDecompressLibNull/BaseCustomDecompressLibNull.c | 82 |
1 files changed, 35 insertions, 47 deletions
diff --git a/MdePkg/Library/BaseCustomDecompressLibNull/BaseCustomDecompressLibNull.c b/MdePkg/Library/BaseCustomDecompressLibNull/BaseCustomDecompressLibNull.c index 7f59a101da..669f937487 100644 --- a/MdePkg/Library/BaseCustomDecompressLibNull/BaseCustomDecompressLibNull.c +++ b/MdePkg/Library/BaseCustomDecompressLibNull/BaseCustomDecompressLibNull.c @@ -1,21 +1,33 @@ -/*++
+/** @file
+ Null implementation of the custom decompress library
-Copyright (c) 2006, Intel Corporation
-All rights reserved. This program and the accompanying materials
-are licensed and made available under the terms and conditions of the BSD License
-which accompanies this distribution. The full text of the license may be found at
-http://opensource.org/licenses/bsd-license.php
-
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+ Copyright (c) 2006 - 2007, Intel Corporation.<BR>
+ All rights reserved. This program and the accompanying materials
+ are licensed and made available under the terms and conditions of the BSD License
+ which accompanies this distribution. The full text of the license may be found at
+ http://opensource.org/licenses/bsd-license.php
+ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
---*/
+**/
#include <Base.h>
#include <Library/CustomDecompressLib.h>
+/** + The internal implementation of *_DECOMPRESS_PROTOCOL.GetInfo().
+ + @param[in] Source The source buffer containing the compressed data. + @param[in] SourceSize The size of source buffer + @param[out] DestinationSize The size of destination buffer. + @param[out] ScratchSize The size of scratch buffer. + + @retval RETURN_SUCCESS The size of destination buffer and the size of scratch buffer are successull retrieved.
+ @retval RETURN_INVALID_PARAMETER The source data is corrupted + +**/
RETURN_STATUS
EFIAPI
CustomDecompressGetInfo (
@@ -24,29 +36,23 @@ CustomDecompressGetInfo ( OUT UINT32 *DestinationSize,
OUT UINT32 *ScratchSize
)
-/*++
-
-Routine Description:
-
- The internal implementation of *_DECOMPRESS_PROTOCOL.GetInfo().
-
-Arguments:
-
- Source - The source buffer containing the compressed data.
- SourceSize - The size of source buffer
- DestinationSize - The size of destination buffer.
- ScratchSize - The size of scratch buffer.
-
-Returns:
-
- RETURN_SUCCESS - The size of destination buffer and the size of scratch buffer are successull retrieved.
- RETURN_INVALID_PARAMETER - The source data is corrupted
-
---*/
{
return RETURN_UNSUPPORTED;
}
+
+/** + The internal implementation of *_DECOMPRESS_PROTOCOL.Decompress().
+ + @param[in] Source The source buffer containing the compressed data. + @param[in] Destination The destination buffer to store the decompressed data + @param[out] Scratch The buffer used internally by the decompress routine. This buffer is needed to store intermediate data.
+ + + @retval RETURN_SUCCESS Decompression is successfull
+ @retval RETURN_INVALID_PARAMETER The source data is corrupted + +**/
RETURN_STATUS
EFIAPI
CustomDecompress (
@@ -54,24 +60,6 @@ CustomDecompress ( IN OUT VOID *Destination,
IN OUT VOID *Scratch
)
-/*++
-
-Routine Description:
-
- The internal implementation of *_DECOMPRESS_PROTOCOL.Decompress().
-
-Arguments:
-
- Source - The source buffer containing the compressed data.
- Destination - The destination buffer to store the decompressed data
- Scratch - The buffer used internally by the decompress routine. This buffer is needed to store intermediate data.
-
-Returns:
-
- RETURN_SUCCESS - Decompression is successfull
- RETURN_INVALID_PARAMETER - The source data is corrupted
-
---*/
{
return RETURN_UNSUPPORTED;
}
|