Commit 2080edee authored by Markus Kauppila's avatar Markus Kauppila

Fixed the doxygen markup.

parent 9ffc5e8e
...@@ -217,7 +217,6 @@ RandomIntegerInRange(Sint32 pMin, Sint32 pMax) ...@@ -217,7 +217,6 @@ RandomIntegerInRange(Sint32 pMin, Sint32 pMax)
* \param validDomain Generate only for valid domain (for the data type) * \param validDomain Generate only for valid domain (for the data type)
* *
* \param outBuffer The generated boundary values are put here * \param outBuffer The generated boundary values are put here
* \param outBufferSize Size of outBuffer
* *
* \returns Returns the number of elements in outBuffer or -1 in case of error * \returns Returns the number of elements in outBuffer or -1 in case of error
*/ */
...@@ -382,7 +381,11 @@ RandomUint64BoundaryValue(Uint64 boundary1, Uint64 boundary2, SDL_bool validDoma ...@@ -382,7 +381,11 @@ RandomUint64BoundaryValue(Uint64 boundary1, Uint64 boundary2, SDL_bool validDoma
* If boundary1 == boundary2, value of boundary1 will be returned * If boundary1 == boundary2, value of boundary1 will be returned
* *
* Generating boundary values for Sint8: * Generating boundary values for Sint8:
* <Add examples> * SignedBoundaryValues(sizeof(Sint8), -10, 20, True) -> [-11,-10,19,20]
* SignedBoundaryValues(sizeof(Sint8), -10, 20, False) -> [-11,21]
* SignedBoundaryValues(sizeof(Sint8), -30, -15, True) -> [-30, -29, -16, -15]
* SignedBoundaryValues(sizeof(Sint8), -128, 15, False) -> [16]
* SignedBoundaryValues(sizeof(Sint8), -128, 127, False) -> NULL
* *
* Generator works the same for other types of signed integers. * Generator works the same for other types of signed integers.
* *
...@@ -390,7 +393,7 @@ RandomUint64BoundaryValue(Uint64 boundary1, Uint64 boundary2, SDL_bool validDoma ...@@ -390,7 +393,7 @@ RandomUint64BoundaryValue(Uint64 boundary1, Uint64 boundary2, SDL_bool validDoma
* If outbuffer != NULL, it'll be freed. * If outbuffer != NULL, it'll be freed.
* *
* *
* \paran minValue The smallest value that is acceptable for this data type. * \param minValue The smallest value that is acceptable for this data type.
* For instance, for Uint8 -> -128, Uint16 -> -32,768 etc. * For instance, for Uint8 -> -128, Uint16 -> -32,768 etc.
* \param maxValue The biggest value that is acceptable for this data type. * \param maxValue The biggest value that is acceptable for this data type.
* For instance, for Uint8 -> 127, Uint16 -> 32767 etc. * For instance, for Uint8 -> 127, Uint16 -> 32767 etc.
...@@ -399,7 +402,6 @@ RandomUint64BoundaryValue(Uint64 boundary1, Uint64 boundary2, SDL_bool validDoma ...@@ -399,7 +402,6 @@ RandomUint64BoundaryValue(Uint64 boundary1, Uint64 boundary2, SDL_bool validDoma
* \param validDomain Generate only for valid domain (for the data type) * \param validDomain Generate only for valid domain (for the data type)
* *
* \param outBuffer The generated boundary values are put here * \param outBuffer The generated boundary values are put here
* \param outBufferSize Size of outBuffer
* *
* \returns Returns the number of elements in outBuffer or -1 in case of error * \returns Returns the number of elements in outBuffer or -1 in case of error
*/ */
......
...@@ -322,12 +322,12 @@ char *RandomAsciiStringWithMaximumLength(int maxLength); ...@@ -322,12 +322,12 @@ char *RandomAsciiStringWithMaximumLength(int maxLength);
* \param runSeed Seed of the harness * \param runSeed Seed of the harness
* \param suiteName Test suite name * \param suiteName Test suite name
* \param testName Test name * \param testName Test name
* \param iteration Number of test iteration * \param iterationNumber of test iteration
* *
* \return Generated execution key as blob of 16 bytes. It needs be deallocated. * \return Generated execution key as blob of 16 bytes. It needs be deallocated.
* On error, returns NULL. * On error, returns NULL.
*/ */
Uint64 GenerateExecKey(char *runSeed, char *suiteName, char *testName, int interationNumber); Uint64 GenerateExecKey(char *runSeed, char *suiteName, char *testName, int iterationNumber);
#endif #endif
...@@ -32,7 +32,7 @@ ...@@ -32,7 +32,7 @@
* \param runnerParameters What parameters were given to the runner * \param runnerParameters What parameters were given to the runner
* \param runSeed Fuzzer seed of the harness * \param runSeed Fuzzer seed of the harness
* \param eventTime When the execution started * \param eventTime When the execution started
* \param loggerData LoggerData structure which contains data for the logger * \param data LoggerData structure which contains data for the logger
* *
*/ */
void PlainRunStarted(int parameterCount, char *runnerParameters[], char *runSeed, void PlainRunStarted(int parameterCount, char *runnerParameters[], char *runSeed,
...@@ -134,8 +134,8 @@ void PlainAssertSummary(int numAsserts, int numAssertsFailed, int numAssertsPass ...@@ -134,8 +134,8 @@ void PlainAssertSummary(int numAsserts, int numAssertsFailed, int numAssertsPass
/*! /*!
* Prints given message * Prints given message
* *
* \param logMessage Message to be logged
* \param eventTime Timestamp for log message * \param eventTime Timestamp for log message
* \param fmt Message to be logged
*/ */
void PlainLog(time_t eventTime, char *fmt, ...); void PlainLog(time_t eventTime, char *fmt, ...);
......
...@@ -32,7 +32,7 @@ ...@@ -32,7 +32,7 @@
* \param runnerParameters What parameters were given to the runner * \param runnerParameters What parameters were given to the runner
* \param runSeed Fuzzer seed of the harness * \param runSeed Fuzzer seed of the harness
* \param eventTime When the execution started * \param eventTime When the execution started
* \param loggerData LoggerData structure which contains data for the logger * \param data LoggerData structure which contains data for the logger
*/ */
void XMLRunStarted(int parameterCount, char *runnerParameters[], char *runSeed, void XMLRunStarted(int parameterCount, char *runnerParameters[], char *runSeed,
time_t eventTime, LoggerData *data); time_t eventTime, LoggerData *data);
...@@ -132,8 +132,8 @@ void XMLAssertSummary(int numAsserts, int numAssertsFailed, int numAssertsPass, ...@@ -132,8 +132,8 @@ void XMLAssertSummary(int numAsserts, int numAssertsFailed, int numAssertsPass,
/*! /*!
* Prints given message in XML * Prints given message in XML
* *
* \param logMessage Message to be logged
* \param eventTime Timestamp for log message * \param eventTime Timestamp for log message
* \param fmt Message to be logged
*/ */
void XMLLog(time_t eventTime, char *fmt, ...); void XMLLog(time_t eventTime, char *fmt, ...);
......
...@@ -824,6 +824,8 @@ RunTest(TestCase *testCase, Uint64 execKey) ...@@ -824,6 +824,8 @@ RunTest(TestCase *testCase, Uint64 execKey)
* be executed in-proc or out-of-proc. * be executed in-proc or out-of-proc.
* *
* \param testItem The test case that will be executed * \param testItem The test case that will be executed
* \param execKey Execution key for the test case
*
* \return The return value of the test. Zero means success, non-zero failure. * \return The return value of the test. Zero means success, non-zero failure.
*/ */
int int
......
...@@ -122,15 +122,6 @@ void rwops_testParam (void) ...@@ -122,15 +122,6 @@ void rwops_testParam (void)
} }
/**
* @brief Does a generic rwops test.
*
* RWops should have "Hello World!" in it already if write is disabled.
*
* @param write Test writing also.
* @return 1 if an assert is failed.
*/
/** /**
* @brief Tests opening from memory. * @brief Tests opening from memory.
* *
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment