Fix comments

This commit is contained in:
Robert Müller 2022-03-05 10:42:19 +01:00
parent c427c04522
commit f4ade69b5e

View file

@ -40,29 +40,27 @@ class CHuffman
public:
/*
Function: huffman_init
Function: Init
Inits the compressor/decompressor.
Parameters:
huff - Pointer to the state to init
frequencies - A pointer to an array of 256 entries of the frequencies of the bytes
pFrequencies - A pointer to an array of 256 entries of the frequencies of the bytes
Remarks:
- Does no allocation what so ever.
- You don't have to call any cleanup functions when you are done with it
- Does no allocation whatsoever.
- You don't have to call any cleanup functions when you are done with it.
*/
void Init(const unsigned *pFrequencies);
/*
Function: huffman_compress
Function: Compress
Compresses a buffer and outputs a compressed buffer.
Parameters:
huff - Pointer to the huffman state
input - Buffer to compress
input_size - Size of the buffer to compress
output - Buffer to put the compressed data into
output_size - Size of the output buffer
pInput - Buffer to compress
InputSize - Size of the buffer to compress
pOutput - Buffer to put the compressed data into
OutputSize - Size of the output buffer
Returns:
Returns the size of the compressed data. Negative value on failure.
@ -70,19 +68,18 @@ public:
int Compress(const void *pInput, int InputSize, void *pOutput, int OutputSize);
/*
Function: huffman_decompress
Function: Decompress
Decompresses a buffer
Parameters:
huff - Pointer to the huffman state
input - Buffer to decompress
input_size - Size of the buffer to decompress
output - Buffer to put the uncompressed data into
output_size - Size of the output buffer
pInput - Buffer to decompress
InputSize - Size of the buffer to decompress
pOutput - Buffer to put the uncompressed data into
OutputSize - Size of the output buffer
Returns:
Returns the size of the uncompressed data. Negative value on failure.
*/
int Decompress(const void *pInput, int InputSize, void *pOutput, int OutputSize);
};
#endif // __HUFFMAN_HEADER__
#endif // ENGINE_SHARED_HUFFMAN_H