pandory500/SDL-mirror
2
0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fixed doxygen tags in header file documentation comments.

Browse source
This commit is contained in:
Philipp Wiesemann 2014-11-23 20:46:34 +01:00
parent 8aba104f96
commit d38aa0a103
3 changed files with 22 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

24
include/SDL_test_crc32.h
View file

@ -70,27 +70,27 @@ extern "C" {
/* ---------- Function Prototypes ------------- */
/**
* /brief Initialize the CRC context
* \brief Initialize the CRC context
*
* Note: The function initializes the crc table required for all crc calculations.
*
* /param crcContext pointer to context variable
* \param crcContext pointer to context variable
*
* /returns 0 for OK, -1 on error
* \returns 0 for OK, -1 on error
*
*/
int SDLTest_Crc32Init(SDLTest_Crc32Context * crcContext);
/**
* /brief calculate a crc32 from a data block
* \brief calculate a crc32 from a data block
*
* /param crcContext pointer to context variable
* /param inBuf input buffer to checksum
* /param inLen length of input buffer
* /param crc32 pointer to Uint32 to store the final CRC into
* \param crcContext pointer to context variable
* \param inBuf input buffer to checksum
* \param inLen length of input buffer
* \param crc32 pointer to Uint32 to store the final CRC into
*
* /returns 0 for OK, -1 on error
* \returns 0 for OK, -1 on error
*
*/
int SDLTest_crc32Calc(SDLTest_Crc32Context * crcContext, CrcUint8 *inBuf, CrcUint32 inLen, CrcUint32 *crc32);
@ -102,11 +102,11 @@ int SDLTest_Crc32CalcBuffer(SDLTest_Crc32Context * crcContext, CrcUint8 *inBuf,
/**
* /brief clean up CRC context
* \brief clean up CRC context
*
* /param crcContext pointer to context variable
* \param crcContext pointer to context variable
*
* /returns 0 for OK, -1 on error
* \returns 0 for OK, -1 on error
*
*/