Fixed old comments and added new ones.
authorMarkus Kauppila <markus.kauppila@gmail.com>
Sat, 04 Jun 2011 18:08:54 +0300
changeset 5680 e61bdd43a2c3
parent 5679 10a5199c4169
child 5681 7abfcc71aa7d
Fixed old comments and added new ones.
test/test-automation/SDL_test.c
test/test-automation/runner.c
--- a/test/test-automation/SDL_test.c	Sat Jun 04 17:58:46 2011 +0300
+++ b/test/test-automation/SDL_test.c	Sat Jun 04 18:08:54 2011 +0300
@@ -48,6 +48,7 @@
 {
 	//! \todo make the test fail, if it does not contain any asserts
 	printf("Asserts: passed %d, failed %d\n", _testAssertsPassed, _testAssertsFailed);
+
 	if(_testAssertsFailed == 0 && _testAssertsPassed == 0) {
 		_testReturnValue = 2;
 	}
@@ -55,6 +56,15 @@
 	return _testReturnValue;
 }
 
+
+/*!
+ *  Assert function. Tests if the expected value equals the actual value, then
+ *  the test assert succeeds, otherwise it fails and warns about it.
+ *
+ * \param expected Value user expects to have
+ * \param actual The actual value of tested variable
+ * \param message Message that will be printed if assert fails
+ */
 void
 AssertEquals(Uint32 expected, Uint32 actual, char* message, ...)
 {
@@ -73,6 +83,14 @@
    }
 }
 
+/*!
+ *  Assert function. Tests if the given condition is true. True in
+ *  this case means non-zero value. If the condition is true, the
+ *  assert passes, otherwise it fails.
+ *
+ * \param condition Condition which will be evaluated
+ * \param message Message that will be printed if assert fails
+ */
 void
 AssertTrue(int condition, char *message, ...)
 {
--- a/test/test-automation/runner.c	Sat Jun 04 17:58:46 2011 +0300
+++ b/test/test-automation/runner.c	Sat Jun 04 18:08:54 2011 +0300
@@ -61,7 +61,7 @@
 /*!
  * Loads test suite which is implemented as dynamic library.
  *
- * \param test0,330
+ * \param testSuiteName Name of the test suite which will be loaded
  *
  * \return Pointer to loaded test suite, or NULL if library could not be loaded
  */