Code DocumentationΒΆ
The code documentation is done using doxygen and converted for sphinx using breathe.
- Assertions
CHECK()CHECK_ANY_RTE()CHECK_CLOSE_CMPLX()CHECK_CLOSE_INT64()CHECK_CLOSE_UINT64()CHECK_CLOSE_VAR()CHECK_COMPILATION()CHECK_EMPTY_FOLDER()CHECK_EMPTY_STR()CHECK_EQUAL_INT64()CHECK_EQUAL_STR()CHECK_EQUAL_TEXTWAVES()CHECK_EQUAL_UINT64()CHECK_EQUAL_VAR()CHECK_EQUAL_WAVES()CHECK_GE_VAR()CHECK_GT_VAR()CHECK_LE_VAR()CHECK_LT_VAR()CHECK_NEQ_INT64()CHECK_NEQ_STR()CHECK_NEQ_UINT64()CHECK_NEQ_VAR()CHECK_NO_COMPILATION()CHECK_NO_RTE()CHECK_NON_EMPTY_STR()CHECK_NON_NULL_STR()CHECK_NULL_STR()CHECK_PROPER_STR()CHECK_RTE()CHECK_SMALL_CMPLX()CHECK_SMALL_INT64()CHECK_SMALL_UINT64()CHECK_SMALL_VAR()CHECK_WAVE()FAIL()INFO()PASS()REQUIRE()REQUIRE_ANY_RTE()REQUIRE_CLOSE_CMPLX()REQUIRE_CLOSE_INT64()REQUIRE_CLOSE_UINT64()REQUIRE_CLOSE_VAR()REQUIRE_COMPILATION()REQUIRE_EMPTY_FOLDER()REQUIRE_EMPTY_STR()REQUIRE_EQUAL_INT64()REQUIRE_EQUAL_STR()REQUIRE_EQUAL_TEXTWAVES()REQUIRE_EQUAL_UINT64()REQUIRE_EQUAL_VAR()REQUIRE_EQUAL_WAVES()REQUIRE_GE_VAR()REQUIRE_GT_VAR()REQUIRE_LE_VAR()REQUIRE_LT_VAR()REQUIRE_NEQ_INT64()REQUIRE_NEQ_STR()REQUIRE_NEQ_UINT64()REQUIRE_NEQ_VAR()REQUIRE_NO_COMPILATION()REQUIRE_NO_RTE()REQUIRE_NON_EMPTY_STR()REQUIRE_NON_NULL_STR()REQUIRE_NULL_STR()REQUIRE_PROPER_STR()REQUIRE_RTE()REQUIRE_SMALL_CMPLX()REQUIRE_SMALL_INT64()REQUIRE_SMALL_UINT64()REQUIRE_SMALL_VAR()REQUIRE_WAVE()SKIP_TESTCASE()SKIP_TESTCASE_EXPECT_FAILS()WARN()WARN_ANY_RTE()WARN_CLOSE_CMPLX()WARN_CLOSE_INT64()WARN_CLOSE_UINT64()WARN_CLOSE_VAR()WARN_COMPILATION()WARN_EMPTY_FOLDER()WARN_EMPTY_STR()WARN_EQUAL_INT64()WARN_EQUAL_STR()WARN_EQUAL_TEXTWAVES()WARN_EQUAL_UINT64()WARN_EQUAL_VAR()WARN_EQUAL_WAVES()WARN_GE_VAR()WARN_GT_VAR()WARN_LE_VAR()WARN_LT_VAR()WARN_NEQ_INT64()WARN_NEQ_STR()WARN_NEQ_UINT64()WARN_NEQ_VAR()WARN_NO_COMPILATION()WARN_NO_RTE()WARN_NON_EMPTY_STR()WARN_NON_NULL_STR()WARN_NULL_STR()WARN_PROPER_STR()WARN_RTE()WARN_SMALL_CMPLX()WARN_SMALL_INT64()WARN_SMALL_UINT64()WARN_SMALL_VAR()WARN_WAVE()
- Logical Flags
