diff --git a/include/micro-os-plus/detail.h b/include/micro-os-plus/detail.h index 5e1424c..37a5495 100644 --- a/include/micro-os-plus/detail.h +++ b/include/micro-os-plus/detail.h @@ -47,6 +47,7 @@ namespace micro_os_plus::micro_test_plus { /** * @brief An object used to pass assertion parameters to the evaluator. + * @headerfile micro-test-plus.h */ template struct assertion @@ -95,6 +96,7 @@ namespace micro_os_plus::micro_test_plus /** * @brief Equality comparator. + * @headerfile micro-test-plus.h */ template struct eq_ : type_traits::op @@ -180,6 +182,7 @@ namespace micro_os_plus::micro_test_plus /** * @brief Non-equality comparator. + * @headerfile micro-test-plus.h */ template struct ne_ : type_traits::op @@ -254,6 +257,7 @@ namespace micro_os_plus::micro_test_plus /** * @brief Greater than comparator. + * @headerfile micro-test-plus.h */ template struct gt_ : type_traits::op @@ -311,6 +315,7 @@ namespace micro_os_plus::micro_test_plus /** * @brief Greater than or equal comparator. + * @headerfile micro-test-plus.h */ template struct ge_ : type_traits::op @@ -368,6 +373,7 @@ namespace micro_os_plus::micro_test_plus /** * @brief Less than comparator. + * @headerfile micro-test-plus.h */ template struct lt_ : type_traits::op @@ -426,6 +432,7 @@ namespace micro_os_plus::micro_test_plus /** * @brief Less than or equal comparator. + * @headerfile micro-test-plus.h */ template struct le_ : type_traits::op @@ -485,6 +492,7 @@ namespace micro_os_plus::micro_test_plus /** * @brief Logical and operator. + * @headerfile micro-test-plus.h */ template struct and_ : type_traits::op @@ -520,6 +528,7 @@ namespace micro_os_plus::micro_test_plus /** * @brief Logical or operator. + * @headerfile micro-test-plus.h */ template struct or_ : type_traits::op @@ -555,6 +564,7 @@ namespace micro_os_plus::micro_test_plus /** * @brief Logical not operator. + * @headerfile micro-test-plus.h */ template struct not_ : type_traits::op @@ -583,6 +593,7 @@ namespace micro_os_plus::micro_test_plus #if defined(__cpp_exceptions) /** * @brief Operator to check if the expression throws a specific exception. + * @headerfile micro-test-plus.h */ template struct throws_ : type_traits::op @@ -617,6 +628,7 @@ namespace micro_os_plus::micro_test_plus /** * @brief Operator to check if the expression throws any exception. + * @headerfile micro-test-plus.h */ template struct throws_ : type_traits::op @@ -647,6 +659,7 @@ namespace micro_os_plus::micro_test_plus /** * @brief Operator to check if the expression does not throw any exception. + * @headerfile micro-test-plus.h */ template struct nothrow_ : type_traits::op @@ -681,6 +694,7 @@ namespace micro_os_plus::micro_test_plus /** * @brief Base class for a deferred reporter, that collects the * messages into a string. + * @headerfile micro-test-plus.h */ class deferred_reporter_base { @@ -715,6 +729,7 @@ namespace micro_os_plus::micro_test_plus /** * @brief Class template for a deferred reporter specific * to an expression. + * @headerfile micro-test-plus.h */ template class deferred_reporter : public deferred_reporter_base diff --git a/include/micro-os-plus/literals.h b/include/micro-os-plus/literals.h index aa8f7a0..224c46a 100644 --- a/include/micro-os-plus/literals.h +++ b/include/micro-os-plus/literals.h @@ -396,12 +396,7 @@ namespace micro_os_plus::micro_test_plus /** * @deprecated Use `to_t` (since 3.2.0). - * @} - */ - - /** - * @ingroup micro-test-plus-literals - * @brief Template for wrapping any other type. + * @headerfile micro-test-plus.h */ template struct _t : type_traits::value @@ -411,7 +406,6 @@ namespace micro_os_plus::micro_test_plus } }; - /** * @addtogroup micro-test-plus-literals * @{ @@ -475,6 +469,7 @@ namespace micro_os_plus::micro_test_plus /** * @ingroup micro-test-plus-literals * @brief Template for wrapping any other type. + * @headerfile micro-test-plus.h * @since 3.2.0 * * @details diff --git a/include/micro-os-plus/reflection.h b/include/micro-os-plus/reflection.h index 8b7010d..3240b2e 100644 --- a/include/micro-os-plus/reflection.h +++ b/include/micro-os-plus/reflection.h @@ -52,6 +52,7 @@ namespace micro_os_plus::micro_test_plus #else /** * @brief Local implementation of the std::source_location. + * @headerfile micro-test-plus.h */ class source_location { diff --git a/include/micro-os-plus/test-reporter.h b/include/micro-os-plus/test-reporter.h index 969fa73..17640fa 100644 --- a/include/micro-os-plus/test-reporter.h +++ b/include/micro-os-plus/test-reporter.h @@ -49,6 +49,7 @@ namespace micro_os_plus::micro_test_plus /** * @brief Colours used to highlight pass vs. fail. + * @headerfile micro-test-plus.h */ struct colors { @@ -59,6 +60,7 @@ namespace micro_os_plus::micro_test_plus /** * @brief The verbosity levels. + * @headerfile micro-test-plus.h */ enum class verbosity { @@ -80,6 +82,7 @@ namespace micro_os_plus::micro_test_plus /** * @brief Reporter to display the test results. For failed * tests it prints the actual values of the operands, with their types. + * @headerfile micro-test-plus.h */ class test_reporter { diff --git a/include/micro-os-plus/test-runner.h b/include/micro-os-plus/test-runner.h index 5ee64d7..7762626 100644 --- a/include/micro-os-plus/test-runner.h +++ b/include/micro-os-plus/test-runner.h @@ -46,6 +46,7 @@ namespace micro_os_plus::micro_test_plus /** * @brief The test runner. It maintains a list of test suites which * automatically register themselves in their constructors. + * @headerfile micro-test-plus.h */ class test_runner { diff --git a/include/micro-os-plus/test-suite.h b/include/micro-os-plus/test-suite.h index f9aa831..72ad5d5 100644 --- a/include/micro-os-plus/test-suite.h +++ b/include/micro-os-plus/test-suite.h @@ -45,6 +45,7 @@ namespace micro_os_plus::micro_test_plus /** * @brief Base class for all test suites. + * @headerfile micro-test-plus.h */ class test_suite_base { @@ -249,6 +250,7 @@ namespace micro_os_plus::micro_test_plus * @ingroup micro-test-plus-test-suites * @brief Test suites are classes that represent a named group of * test cases which self register to the runner. + * @headerfile micro-test-plus.h */ class test_suite : public test_suite_base { diff --git a/include/micro-os-plus/type-traits.h b/include/micro-os-plus/type-traits.h index 976d036..78b3f4b 100644 --- a/include/micro-os-plus/type-traits.h +++ b/include/micro-os-plus/type-traits.h @@ -45,11 +45,17 @@ namespace micro_os_plus::micro_test_plus */ namespace type_traits { + /** + * @headerfile micro-test-plus.h + */ template struct list { }; + /** + * @headerfile micro-test-plus.h + */ template struct identity { @@ -69,6 +75,9 @@ namespace micro_os_plus::micro_test_plus }; #endif + /** + * @headerfile micro-test-plus.h + */ template struct function_traits { @@ -76,6 +85,9 @@ namespace micro_os_plus::micro_test_plus using args = list; }; + /** + * @headerfile micro-test-plus.h + */ template struct function_traits { @@ -83,6 +95,9 @@ namespace micro_os_plus::micro_test_plus using args = list; }; + /** + * @headerfile micro-test-plus.h + */ template struct function_traits { @@ -90,6 +105,9 @@ namespace micro_os_plus::micro_test_plus using args = list; }; + /** + * @headerfile micro-test-plus.h + */ template struct function_traits { @@ -159,11 +177,17 @@ namespace micro_os_plus::micro_test_plus constexpr auto is_convertible_v = is_convertible (0); #endif + /** + * @headerfile micro-test-plus.h + */ template struct requires_ { }; + /** + * @headerfile micro-test-plus.h + */ template <> struct requires_ { @@ -175,6 +199,7 @@ namespace micro_os_plus::micro_test_plus /** * @brief Empty base class of all operators. + * @headerfile micro-test-plus.h */ struct op { @@ -183,6 +208,7 @@ namespace micro_os_plus::micro_test_plus /** * @brief A generic integral constant. * It has a getter and a '-' operator to return the negative value. + * @headerfile micro-test-plus.h */ template struct integral_constant : op @@ -213,6 +239,7 @@ namespace micro_os_plus::micro_test_plus * @brief A generic floating point constant, with custom size * and precision. * It has a getter and a '-' operator to return the negative value. + * @headerfile micro-test-plus.h */ template struct floating_point_constant : op @@ -242,6 +269,9 @@ namespace micro_os_plus::micro_test_plus } }; + /** + * @headerfile micro-test-plus.h + */ template struct genuine_integral_value : op { @@ -271,6 +301,7 @@ namespace micro_os_plus::micro_test_plus /** * @brief Class defining a generic value, accessible via a getter. + * @headerfile micro-test-plus.h */ template struct value : type_traits::op @@ -301,6 +332,7 @@ namespace micro_os_plus::micro_test_plus * in addition to the actual value, has an epsilon, to use the * desired precision during comparisons. * If missing, the default is 1 / (10^decimals). + * @headerfile micro-test-plus.h */ template struct value