sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

BaseTools: Source/C/Common: Fix doc block locations and convert to Doxygen

Browse Source 
Move the documentation blocks from between the parameter list and function
body to above the function.

Convert all the documentation blocks to Doxygen format.

Signed-off-by: Rebecca Cran <rebecca@bsdio.com>
Reviewed-by: Liming Gao <gaoliming@byosoft.com.cn>
This commit is contained in:
Rebecca Cran
2023-02-19 23:21:43 -07:00
committed by mergify[bot]
parent cf6a0a52b0
commit b4e2cf092a
29 changed files with 2112 additions and 4105 deletions
Download Patch File Download Diff File Expand all files Collapse all files

100
BaseTools/Source/C/Common/Decompress.h
View File

@@ -11,13 +11,6 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
#include <Common/UefiBaseTypes.h>
EFI_STATUS
EfiGetInfo (
IN VOID *Source,
IN UINT32 SrcSize,
OUT UINT32 *DstSize,
OUT UINT32 *ScratchSize
);
/**
Routine Description:
@@ -37,7 +30,27 @@ Returns:
EFI_INVALID_PARAMETER - The source data is corrupted
**/
EFI_STATUS
EfiGetInfo (
IN VOID *Source,
IN UINT32 SrcSize,
OUT UINT32 *DstSize,
OUT UINT32 *ScratchSize
);
/**
The implementation of Efi Decompress().
@param Source The source buffer containing the compressed data.
@param SrcSize The size of source buffer
@param Destination The destination buffer to store the decompressed data
@param DstSize The size of destination buffer.
@param Scratch The buffer used internally by the decompress routine. This buffer is needed to store intermediate data.
@param ScratchSize The size of scratch buffer.
@retval EFI_SUCCESS Decompression is successful
@retval EFI_INVALID_PARAMETER The source data is corrupted
**/
EFI_STATUS
EfiDecompress (
IN VOID *Source,
@@ -47,28 +60,18 @@ EfiDecompress (
IN OUT VOID *Scratch,
IN UINT32 ScratchSize
);
/**
The implementation Tiano Decompress GetInfo().
Routine Description:
The implementation of Efi Decompress().
Arguments:
Source - The source buffer containing the compressed data.
SrcSize - The size of source buffer
Destination - The destination buffer to store the decompressed data
DstSize - The size of destination buffer.
Scratch - The buffer used internally by the decompress routine. This buffer is needed to store intermediate data.
ScratchSize - The size of scratch buffer.
Returns:
EFI_SUCCESS - Decompression is successful
EFI_INVALID_PARAMETER - The source data is corrupted
@param Source The source buffer containing the compressed data.
@param SrcSize The size of source buffer
@param DstSize The size of destination buffer.
@param ScratchSize The size of scratch buffer.
@retval EFI_SUCCESS The size of destination buffer and the size of scratch buffer are successfully retrieved.
@retval EFI_INVALID_PARAMETER The source data is corrupted
**/
EFI_STATUS
TianoGetInfo (
IN VOID *Source,
@@ -76,26 +79,20 @@ TianoGetInfo (
OUT UINT32 *DstSize,
OUT UINT32 *ScratchSize
);
/**
The implementation of Tiano Decompress().
Routine Description:
The implementation Tiano Decompress GetInfo().
Arguments:
Source - The source buffer containing the compressed data.
SrcSize - The size of source buffer
DstSize - The size of destination buffer.
ScratchSize - The size of scratch buffer.
Returns:
EFI_SUCCESS - The size of destination buffer and the size of scratch buffer are successfully retrieved.
EFI_INVALID_PARAMETER - The source data is corrupted
@param Source The source buffer containing the compressed data.
@param SrcSize The size of source buffer
@param Destination The destination buffer to store the decompressed data
@param DstSize The size of destination buffer.
@param Scratch The buffer used internally by the decompress routine. This buffer is needed to store intermediate data.
@param ScratchSize The size of scratch buffer.
@retval EFI_SUCCESS Decompression is successful
@retval EFI_INVALID_PARAMETER The source data is corrupted
**/
EFI_STATUS
TianoDecompress (
IN VOID *Source,
@@ -105,27 +102,6 @@ TianoDecompress (
IN OUT VOID *Scratch,
IN UINT32 ScratchSize
);
/**
Routine Description:
The implementation of Tiano Decompress().
Arguments:
Source - The source buffer containing the compressed data.
SrcSize - The size of source buffer
Destination - The destination buffer to store the decompressed data
DstSize - The size of destination buffer.
Scratch - The buffer used internally by the decompress routine. This buffer is needed to store intermediate data.
ScratchSize - The size of scratch buffer.
Returns:
EFI_SUCCESS - Decompression is successful
EFI_INVALID_PARAMETER - The source data is corrupted
**/
typedef
EFI_STATUS