include/SDL_test_harness.h
changeset 7678 286c42d7c5ed
parent 7677 871d43c6968a
child 8149 681eb46b8ac4
     1.1 --- a/include/SDL_test_harness.h	Wed Aug 21 09:43:09 2013 -0300
     1.2 +++ b/include/SDL_test_harness.h	Wed Aug 21 09:47:10 2013 -0300
     1.3 @@ -43,43 +43,43 @@
     1.4  #endif
     1.5  
     1.6  
     1.7 -/*! Definitions for test case structures */
     1.8 +/* ! Definitions for test case structures */
     1.9  #define TEST_ENABLED  1
    1.10  #define TEST_DISABLED 0
    1.11  
    1.12 -/*! Definition of all the possible test return values of the test case method */
    1.13 +/* ! Definition of all the possible test return values of the test case method */
    1.14  #define TEST_ABORTED        -1
    1.15  #define TEST_STARTED         0
    1.16  #define TEST_COMPLETED       1
    1.17  #define TEST_SKIPPED         2
    1.18  
    1.19 -/*! Definition of all the possible test results for the harness */
    1.20 +/* ! Definition of all the possible test results for the harness */
    1.21  #define TEST_RESULT_PASSED              0
    1.22  #define TEST_RESULT_FAILED              1
    1.23  #define TEST_RESULT_NO_ASSERT           2
    1.24  #define TEST_RESULT_SKIPPED             3
    1.25  #define TEST_RESULT_SETUP_FAILURE       4
    1.26  
    1.27 -/*!< Function pointer to a test case setup function (run before every test) */
    1.28 +/* !< Function pointer to a test case setup function (run before every test) */
    1.29  typedef void (*SDLTest_TestCaseSetUpFp)(void *arg);
    1.30  
    1.31 -/*!< Function pointer to a test case function */
    1.32 +/* !< Function pointer to a test case function */
    1.33  typedef int (*SDLTest_TestCaseFp)(void *arg);
    1.34  
    1.35 -/*!< Function pointer to a test case teardown function (run after every test) */
    1.36 +/* !< Function pointer to a test case teardown function (run after every test) */
    1.37  typedef void  (*SDLTest_TestCaseTearDownFp)(void *arg);
    1.38  
    1.39  /**
    1.40   * Holds information about a single test case.
    1.41   */
    1.42  typedef struct SDLTest_TestCaseReference {
    1.43 -    /*!< Func2Stress */
    1.44 +    /* !< Func2Stress */
    1.45      SDLTest_TestCaseFp testCase;
    1.46 -    /*!< Short name (or function name) "Func2Stress" */
    1.47 +    /* !< Short name (or function name) "Func2Stress" */
    1.48      char *name;
    1.49 -    /*!< Long name or full description "This test pushes func2() to the limit." */
    1.50 +    /* !< Long name or full description "This test pushes func2() to the limit." */
    1.51      char *description;
    1.52 -    /*!< Set to TEST_ENABLED or TEST_DISABLED (test won't be run) */
    1.53 +    /* !< Set to TEST_ENABLED or TEST_DISABLED (test won't be run) */
    1.54      int enabled;
    1.55  } SDLTest_TestCaseReference;
    1.56  
    1.57 @@ -87,13 +87,13 @@
    1.58   * Holds information about a test suite (multiple test cases).
    1.59   */
    1.60  typedef struct SDLTest_TestSuiteReference {
    1.61 -    /*!< "PlatformSuite" */
    1.62 +    /* !< "PlatformSuite" */
    1.63      char *name;
    1.64 -    /*!< The function that is run before each test. NULL skips. */
    1.65 +    /* !< The function that is run before each test. NULL skips. */
    1.66      SDLTest_TestCaseSetUpFp testSetUp;
    1.67 -    /*!< The test cases that are run as part of the suite. Last item should be NULL. */
    1.68 +    /* !< The test cases that are run as part of the suite. Last item should be NULL. */
    1.69      const SDLTest_TestCaseReference **testCases;
    1.70 -    /*!< The function that is run after each test. NULL skips. */
    1.71 +    /* !< The function that is run after each test. NULL skips. */
    1.72      SDLTest_TestCaseTearDownFp testTearDown;
    1.73  } SDLTest_TestSuiteReference;
    1.74