Skip to content
Permalink
Browse files

Fixed doxygen tags in header file documentation comments.

  • Loading branch information
philippwiesemann committed Nov 23, 2014
1 parent c016597 commit 43e5c9ee00128c79d4714f7a9afcbe4482d378a2
Showing with 22 additions and 22 deletions.
  1. +12 −12 include/SDL_test_crc32.h
  2. +1 −1 include/SDL_test_fuzzer.h
  3. +9 −9 include/SDL_test_md5.h
@@ -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
*
*/

@@ -57,7 +57,7 @@ extern "C" {
/**
* Initializes the fuzzer for a test
*
* /param execKey Execution "Key" that initializes the random number generator uniquely for the test.
* \param execKey Execution "Key" that initializes the random number generator uniquely for the test.
*
*/
void SDLTest_FuzzerInit(Uint64 execKey);
@@ -78,9 +78,9 @@ extern "C" {
/* ---------- Function Prototypes ------------- */

/**
* /brief initialize the context
* \brief initialize the context
*
* /param mdContext pointer to context variable
* \param mdContext pointer to context variable
*
* Note: The function initializes the message-digest context
* mdContext. Call before each new use of the context -
@@ -90,11 +90,11 @@ extern "C" {


/**
* /brief update digest from variable length data
* \brief update digest from variable length data
*
* /param mdContext pointer to context variable
* /param inBuf pointer to data array/string
* /param inLen length of data array/string
* \param mdContext pointer to context variable
* \param inBuf pointer to data array/string
* \param inLen length of data array/string
*
* Note: The function updates the message-digest context to account
* for the presence of each of the characters inBuf[0..inLen-1]
@@ -105,10 +105,10 @@ extern "C" {
unsigned int inLen);


/*
* /brief complete digest computation
/**
* \brief complete digest computation
*
* /param mdContext pointer to context variable
* \param mdContext pointer to context variable
*
* Note: The function terminates the message-digest computation and
* ends with the desired message digest in mdContext.digest[0..15].

0 comments on commit 43e5c9e

Please sign in to comment.