Skip to content

Commit

Permalink
Cleanup summary comments in ExtraTests
Browse files Browse the repository at this point in the history
  • Loading branch information
horenmar committed Jan 28, 2022
1 parent 635db27 commit 79e4cd1
Show file tree
Hide file tree
Showing 7 changed files with 35 additions and 21 deletions.
11 changes: 7 additions & 4 deletions tests/ExtraTests/X01-PrefixedMacros.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,13 @@

// SPDX-License-Identifier: BSL-1.0

// X01-DisableStringification.cpp
// Test that Catch's prefixed macros compile and run properly.
// This won't provide full coverage, but it might be worth checking
// the other branch as well
/**\file
* Test that Catch's prefixed macros compile and run properly.
*
* We intentionally do not provide full coverage of all macros, but we
* test a smattering and can add other ones as they have regressions.
*/


#include <catch2/catch_test_macros.hpp>
#include <catch2/matchers/catch_matchers_predicate.hpp>
Expand Down
8 changes: 5 additions & 3 deletions tests/ExtraTests/X02-DisabledMacros.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,11 @@

// SPDX-License-Identifier: BSL-1.0

// X02-DisabledMacros.cpp
// Test that CATCH_CONFIG_DISABLE turns off TEST_CASE autoregistration
// and expressions in assertion macros are not run.
/**\file
* Test that CATCH_CONFIG_DISABLE turns off TEST_CASE autoregistration
* and expressions in assertion macros are not run.
*/


#include <catch2/catch_test_macros.hpp>
#include <catch2/benchmark/catch_benchmark.hpp>
Expand Down
9 changes: 7 additions & 2 deletions tests/ExtraTests/X10-FallbackStringifier.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,13 @@

// SPDX-License-Identifier: BSL-1.0

// X10-FallbackStringifier.cpp
// Test that defining fallbackStringifier compiles
/**\file
* Test that the user can define custom fallbackStringifier
*
* This is done by defining a custom fallback stringifier that prints
* out a specific string, and then asserting (to cause stringification)
* over a type without stringification support.
*/

#include <string>

Expand Down
12 changes: 7 additions & 5 deletions tests/ExtraTests/X11-DisableStringification.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,13 @@

// SPDX-License-Identifier: BSL-1.0

// X11-DisableStringification.cpp
// Test that stringification of original expression can be disabled
// this is a workaround for VS 2017 issue with Raw String literal
// and preprocessor token pasting. In other words, hopefully this test
// will be deleted soon :-)
/**\file
* Test that stringification of original expression can be disabled.
*
* This is a workaround for VS 2017, 2019 issue with Raw String literals
* and preprocessor token pasting.
*/


#include <catch2/catch_test_macros.hpp>

Expand Down
5 changes: 3 additions & 2 deletions tests/ExtraTests/X12-CustomDebugBreakMacro.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@

// SPDX-License-Identifier: BSL-1.0

// X12-CustomDebugBreakMacro.cpp
// Test that user-defined `CATCH_BREAK_INTO_DEBUGGER` is respected and used.
/**\file
* Test that user-defined `CATCH_BREAK_INTO_DEBUGGER` is respected and used.
*/

#include <iostream>

Expand Down
10 changes: 6 additions & 4 deletions tests/ExtraTests/X90-WindowsHeaderInclusion.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,12 @@

// SPDX-License-Identifier: BSL-1.0

// X90-WindowsHeaderInclusion.cpp
// Test that the Catch2 header compiles even after including windows.h
// without defining NOMINMAX first. As an FYI, if you do that, you are
// wrong.
/**\file
* Test that the Catch2 header compiles even after including windows.h
* without defining NOMINMAX first.
*
* As an FYI, if you do that, you are wrong.
*/

#include <windows.h>
#include <catch2/catch_test_macros.hpp>
Expand Down
1 change: 0 additions & 1 deletion tests/ExtraTests/X91-AmalgamatedCatch.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
// SPDX-License-Identifier: BSL-1.0

/**\file
*
* This file serves as a simple compilation test against the amalgamated
* version of Catch2.
*/
Expand Down

0 comments on commit 79e4cd1

Please sign in to comment.