summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorPhilipp Wiesemann <philipp.wiesemann@arcor.de>2014-11-23 20:46:34 +0100
committerPhilipp Wiesemann <philipp.wiesemann@arcor.de>2014-11-23 20:46:34 +0100
commit581758565f9f81c8e0c654491c90919da3d53e03 (patch)
treeca9815f9b66df5e65b17e6179b614e8eff4f457d /include
parent7aa87187860455d0942aab60f641c0681a9553a3 (diff)
Fixed doxygen tags in header file documentation comments.
Diffstat (limited to 'include')
-rw-r--r--include/SDL_test_crc32.h24
-rw-r--r--include/SDL_test_fuzzer.h2
-rw-r--r--include/SDL_test_md5.h18
3 files changed, 22 insertions, 22 deletions
diff --git a/include/SDL_test_crc32.h b/include/SDL_test_crc32.h
index a180fe3bbc..f0e80e6419 100644
--- a/include/SDL_test_crc32.h
+++ b/include/SDL_test_crc32.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
*
*/
diff --git a/include/SDL_test_fuzzer.h b/include/SDL_test_fuzzer.h
index 868cc0db15..61d7e35702 100644
--- a/include/SDL_test_fuzzer.h
+++ b/include/SDL_test_fuzzer.h
@@ -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);
diff --git a/include/SDL_test_md5.h b/include/SDL_test_md5.h
index 029e164bf8..7bc39b2209 100644
--- a/include/SDL_test_md5.h
+++ b/include/SDL_test_md5.h
@@ -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].