diff options
| author | Arash Badie-Modiri | 2023-01-13 15:07:46 +0200 |
|---|---|---|
| committer | Martin Hořeňovský | 2023-01-18 23:16:55 +0100 |
| commit | 956f915e3133df5c3d9b92b6e293d2f8fe20cd76 (patch) | |
| tree | c952b2d06afc306efd79e660572a00fdc67b98c8 | |
| parent | aa8da505ec3ce0ef08728c4bb3c104bfd23506eb (diff) | |
| download | catch3-956f915e3133df5c3d9b92b6e293d2f8fe20cd76.tar.gz | |
Document template macros are in spearate header
Type parametrised and signature parametrised test macros are now in their own header. The documentation should reflect that.
| -rw-r--r-- | docs/test-cases-and-sections.md | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/docs/test-cases-and-sections.md b/docs/test-cases-and-sections.md index a5d0aacc..28720941 100644 --- a/docs/test-cases-and-sections.md +++ b/docs/test-cases-and-sections.md @@ -168,7 +168,11 @@ Other than the additional prefixes and the formatting in the console reporter th In addition to `TEST_CASE`s, Catch2 also supports test cases parametrised by types, in the form of `TEMPLATE_TEST_CASE`, -`TEMPLATE_PRODUCT_TEST_CASE` and `TEMPLATE_LIST_TEST_CASE`. +`TEMPLATE_PRODUCT_TEST_CASE` and `TEMPLATE_LIST_TEST_CASE`. These macros +are defined in the `catch_template_test_macros.hpp` header, so compiling +the code examples below also requires +`#include <catch2/catch_template_test_macros.hpp>`. + * **TEMPLATE_TEST_CASE(** _test name_ , _tags_, _type1_, _type2_, ..., _typen_ **)** @@ -290,7 +294,9 @@ TEMPLATE_LIST_TEST_CASE("Template test case with test types specified inside std In addition to [type parametrised test cases](#type-parametrised-test-cases) Catch2 also supports signature base parametrised test cases, in form of `TEMPLATE_TEST_CASE_SIG` and `TEMPLATE_PRODUCT_TEST_CASE_SIG`. These test cases have similar syntax like [type parametrised test cases](#type-parametrised-test-cases), with one -additional positional argument which specifies the signature. +additional positional argument which specifies the signature. These macros are defined in the +`catch_template_test_macros.hpp` header, so compiling the code examples below also requires +`#include <catch2/catch_template_test_macros.hpp>`. ### Signature Signature has some strict rules for these tests cases to work properly: |