Fixes to doxygen comments.
authorMarkus Kauppila <markus.kauppila@gmail.com>
Tue, 31 May 2011 14:40:28 +0300
changeset 56758513baf78c95
parent 5674 1ee88babe722
child 5676 02a0f7889834
Fixes to doxygen comments.
Changed some printf() to fprints(stderr).
test/test-automation/runner.c
     1.1 --- a/test/test-automation/runner.c	Mon May 30 21:57:04 2011 +0300
     1.2 +++ b/test/test-automation/runner.c	Tue May 31 14:40:28 2011 +0300
     1.3 @@ -33,7 +33,7 @@
     1.4  /*!
     1.5   * Loads test suite which is implemented as dynamic library.
     1.6   *
     1.7 - * \return Loaded test suite
     1.8 + * \return Pointer to loaded test suite, or NULL if library could not be loaded
     1.9   */
    1.10  void *
    1.11  LoadTestSuite()
    1.12 @@ -46,8 +46,8 @@
    1.13  
    1.14  	void *library = SDL_LoadObject(libName);
    1.15  	if(library == NULL) {
    1.16 -		printf("Loading %s failed\n", libName);
    1.17 -		printf("%s\n", SDL_GetError());
    1.18 +		fprintf(stderr, "Loading %s failed\n", libName);
    1.19 +		fprintf(stderr, "%s\n", SDL_GetError());
    1.20  	}
    1.21  
    1.22  	return library;
    1.23 @@ -57,7 +57,7 @@
    1.24   * Loads the test case references from the given test suite.
    1.25  
    1.26   * \param library Previously loaded dynamic library AKA test suite
    1.27 - * \return Loaded TestCaseReferences
    1.28 + * \return Pointer to array of TestCaseReferences or NULL if function failed
    1.29   */
    1.30  TestCaseReference **
    1.31  QueryTestCases(void *library)
    1.32 @@ -66,14 +66,14 @@
    1.33  
    1.34  	suite = (TestCaseReference **(*)(void)) SDL_LoadFunction(library, "QueryTestSuite");
    1.35  	if(suite == NULL) {
    1.36 -		printf("Loading QueryTestCaseReferences() failed.\n");
    1.37 -		printf("%s\n", SDL_GetError());
    1.38 +		fprintf(stderr, "Loading QueryTestCaseReferences() failed.\n");
    1.39 +		fprintf(stderr, "%s\n", SDL_GetError());
    1.40  	}
    1.41  
    1.42  	TestCaseReference **tests = suite();
    1.43  	if(tests == NULL) {
    1.44 -		printf("Failed to load test references.\n");
    1.45 -		printf("%s\n", SDL_GetError());
    1.46 +		fprintf(stderr, "Failed to load test references.\n");
    1.47 +		fprintf(stderr, "%s\n", SDL_GetError());
    1.48  	}
    1.49  
    1.50  	return tests;
    1.51 @@ -85,15 +85,15 @@
    1.52   * \param suite a test suite
    1.53   * \param testName Name of the test that is going to be loaded
    1.54   *
    1.55 - * \return loaded test
    1.56 + * \return Function Pointer (TestCase) to loaded test case, NULL if function failed
    1.57   */
    1.58  TestCase
    1.59  LoadTestCase(void *suite, char *testName)
    1.60  {
    1.61  	TestCase test = (int (*)(void *)) SDL_LoadFunction(suite, testName);
    1.62  	if(test == NULL) {
    1.63 -		printf("Loading test failed, tests == NULL\n");
    1.64 -		printf("%s\n", SDL_GetError());
    1.65 +		fprintf(stderr, "Loading test failed, tests == NULL\n");
    1.66 +		fprintf(stderr, "%s\n", SDL_GetError());
    1.67  	}
    1.68  
    1.69  	return test;
    1.70 @@ -120,9 +120,8 @@
    1.71  		returnValue = WEXITSTATUS(stat_lock);
    1.72  	} else if(WIFSIGNALED(stat_lock)) {
    1.73  		int signal = WTERMSIG(stat_lock);
    1.74 -		printf("FAILURE: test was aborted due to signal nro %d\n", signal);
    1.75 +		fprintf(stderr, "FAILURE: test was aborted due to signal no %d\n", signal);
    1.76  		returnValue = 1;
    1.77 -	} else if(WIFSTOPPED(stat_lock)) {
    1.78  	}
    1.79  
    1.80  	return returnValue;
    1.81 @@ -147,6 +146,12 @@
    1.82     }
    1.83  }
    1.84  
    1.85 +/*!
    1.86 + * Entry point for test runner
    1.87 + *
    1.88 + * \param argc Count of command line arguments
    1.89 + * \param argv Array of commond lines arguments
    1.90 + */
    1.91  int
    1.92  main(int argc, char *argv[])
    1.93  {