ucx/test.h

changeset 135
a0aa1c15f46b
parent 134
4d320dc3a7af
child 138
7800811078b8
equal deleted inserted replaced
134:4d320dc3a7af 135:a0aa1c15f46b
80 extern "C" { 80 extern "C" {
81 #endif 81 #endif
82 82
83 #ifndef __FUNCTION__ 83 #ifndef __FUNCTION__
84 /** 84 /**
85 * Alias for the __func__ preprocessor macro. 85 * Alias for the <code>__func__</code> preprocessor macro.
86 * Some compilers use __func__ and others use __FUNC__. We use __FUNC__ so we 86 * Some compilers use <code>__func__</code> and others use __FUNC__.
87 * define it for those compilers which use __func__. 87 * We use __FUNC__ so we define it for those compilers which use
88 * <code>__func__</code>.
88 */ 89 */
89 #define __FUNCTION__ __func__ 90 #define __FUNCTION__ __func__
90 #endif 91 #endif
91 92
92 /** Type for the internal list of test cases. */ 93 /** Type for the internal list of test cases. */
125 /** 126 /**
126 * Registers a test function with the specified test suite. 127 * Registers a test function with the specified test suite.
127 * 128 *
128 * @param suite the suite, the test function shall be added to 129 * @param suite the suite, the test function shall be added to
129 * @param test the test function to register 130 * @param test the test function to register
130 * @return EXIT_SUCCESS on success or EXIT_FAILURE on failure 131 * @return <code>EXIT_SUCCESS</code> on success or
132 * <code>EXIT_FAILURE</code> on failure
131 */ 133 */
132 int ucx_test_register(UcxTestSuite* suite, UcxTest test); 134 int ucx_test_register(UcxTestSuite* suite, UcxTest test);
133 /** 135 /**
134 * Runs a test suite and writes the test log to the specified stream. 136 * Runs a test suite and writes the test log to the specified stream.
135 * @param suite the test suite to run 137 * @param suite the test suite to run

mercurial