Fixed doxygen comments and usage help.
authorMarkus Kauppila
Thu, 09 Jun 2011 18:30:06 +0300
changeset 5696e902fa6e6960
parent 5695 6d81a581e6f5
child 5697 0dfe2e85dfd1
Fixed doxygen comments and usage help.
test/test-automation/runner.c
     1.1 --- a/test/test-automation/runner.c	Thu Jun 09 18:13:46 2011 +0300
     1.2 +++ b/test/test-automation/runner.c	Thu Jun 09 18:30:06 2011 +0300
     1.3 @@ -111,6 +111,7 @@
     1.4   * test will be loaded.
     1.5   *
     1.6   * \param directoryName Name of the directory which will be scanned
     1.7 + * \param extension What file extension is used with dynamic objects
     1.8   *
     1.9   * \return Pointer to TestSuiteReference which holds all the info about suites
    1.10   */
    1.11 @@ -177,7 +178,7 @@
    1.12   * during the process. Function will only return the
    1.13   * test cases which aren't filtered out.
    1.14   *
    1.15 - * \param suite previously loaded test suites
    1.16 + * \param suites previously loaded test suites
    1.17   *
    1.18   * \return Test cases that survived filtering process.
    1.19   */
    1.20 @@ -472,8 +473,7 @@
    1.21   * Executes a test case. Loads the test, executes it and
    1.22   * returns the tests return value to the caller.
    1.23   *
    1.24 - * \param suite The suite from which the test will be loaded
    1.25 - * \param testReference TestCaseReference of the test under execution
    1.26 + * \param testItem The test case that will be executed
    1.27   * \return The return value of the test. Zero means success, non-zero failure.
    1.28   */
    1.29  int
    1.30 @@ -510,14 +510,16 @@
    1.31   */
    1.32  void
    1.33  printUsage() {
    1.34 -	  printf("Usage: ./runner [--in-proc] [--suite SUITE] [--test TEST] [--help]\n");
    1.35 +	  printf("Usage: ./runner [--in-proc] [--suite SUITE] [--test TEST]\n");
    1.36 +	  printf("                [--name-contains SUBSTR] [--help]\n");
    1.37  	  printf("Options:\n");
    1.38 -	  printf("     --in-proc                           Executes tests in-process\n");
    1.39 -	  printf(" -t  --test TEST                         Executes only tests with given name\n");
    1.40 -	  printf(" -ts --test-name-contains SUBSTRING      Executes only tests which test name has the given substring\n");
    1.41 -	  printf(" -s  --suite SUITE    Executes only the given test suite\n");
    1.42 +	  printf("     --in-proc                Executes tests in-process\n");
    1.43 +	  printf(" -t  --test TEST              Executes only tests with given name\n");
    1.44 +	  printf(" -ts --name-contains SUBSTR   Executes only tests that have given\n");
    1.45 +	  printf("                              substring in test name\n");
    1.46 +	  printf(" -s  --suite SUITE            Executes only the given test suite\n");
    1.47  
    1.48 -	  printf(" -h --help           Print this help\n");
    1.49 +	  printf(" -h  --help                   Print this help\n");
    1.50  }
    1.51  
    1.52  
    1.53 @@ -556,7 +558,7 @@
    1.54      	  memset(selected_test_name, 0, NAME_BUFFER_SIZE);
    1.55      	  strcpy(selected_test_name, testName);
    1.56        }
    1.57 -      else if(SDL_strcmp(arg, "--test-name-contains") == 0 || SDL_strcmp(arg, "-ts") == 0) {
    1.58 +      else if(SDL_strcmp(arg, "--name-contains") == 0 || SDL_strcmp(arg, "-ts") == 0) {
    1.59      	  only_tests_with_string = 1;
    1.60      	  char *substring = NULL;
    1.61