Commit 43e5c9ee00128c79d4714f7a9afcbe4482d378a2
2014-11-23T20:46:34
Fixed doxygen tags in header file documentation comments.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115
diff --git a/include/SDL_test_crc32.h b/include/SDL_test_crc32.h
index a180fe3..f0e80e6 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 868cc0d..61d7e35 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 029e164..7bc39b2 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].