2017-08-24 15:21:36 +02:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								<a id="top"></a>
							 | 
						
					
						
							
								
									
										
										
										
											2017-08-24 22:21:54 +02:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								# Reference
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							
								
									
										
										
										
											2017-11-03 13:05:09 +00:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								To get the most out of Catch2, start with the [tutorial](tutorial.md#top).
							 | 
						
					
						
							
								
									
										
										
										
											2017-03-15 09:08:20 +00:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								Once you're up and running consider the following reference material.
							 | 
						
					
						
							
								
									
										
										
										
											2014-08-15 14:12:53 +02:00
										 
									 
								 
							 | 
							
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							
								
									
										
										
										
											2017-03-15 09:08:20 +00:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								Writing tests:
							 | 
						
					
						
							
								
									
										
										
										
											2017-08-24 15:33:38 +02:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								* [Assertion macros](assertions.md#top)
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								* [Matchers](matchers.md#top)
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								* [Logging macros](logging.md#top)
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								* [Test cases and sections](test-cases-and-sections.md#top)
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								* [Test fixtures](test-fixtures.md#top)
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								* [Reporters](reporters.md#top)
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								* [Event Listeners](event-listeners.md#top)
							 | 
						
					
						
							
								
									
										
										
										
											2018-08-23 16:32:43 +02:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								* [Data Generators](generators.md#top)
							 | 
						
					
						
							
								
									
										
										
										
											2018-09-17 10:51:44 +02:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								* [Other macros](other-macros.md#top)
							 | 
						
					
						
							
								
									
										
										
										
											2019-06-15 09:23:00 +02:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								* [Micro benchmarking](benchmarks.md#top)
							 | 
						
					
						
							
								
									
										
										
										
											2017-03-15 09:08:20 +00:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								Fine tuning:
							 | 
						
					
						
							
								
									
										
										
										
											2017-08-24 15:33:38 +02:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								* [Supplying your own main()](own-main.md#top)
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								* [Compile-time configuration](configuration.md#top)
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								* [String Conversions](tostring.md#top)
							 | 
						
					
						
							
								
									
										
										
										
											2017-03-15 09:08:20 +00:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								Running:
							 | 
						
					
						
							
								
									
										
										
										
											2017-08-24 15:33:38 +02:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								* [Command line](command-line.md#top)
							 | 
						
					
						
							
								
									
										
										
										
											2018-06-21 23:34:17 +02:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								Odds and ends:
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								* [CMake integration](cmake-integration.md#top)
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								* [CI and other miscellaneous pieces](ci-and-misc.md#top)
							 | 
						
					
						
							
								
									
										
										
										
											2017-03-15 09:08:20 +00:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								FAQ:
							 | 
						
					
						
							
								
									
										
										
										
											2017-08-24 15:33:38 +02:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								* [Why are my tests slow to compile?](slow-compiles.md#top)
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								* [Known limitations](limitations.md#top)
							 | 
						
					
						
							
								
									
										
										
										
											2017-02-14 11:24:15 +00:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								 
							 | 
						
					
						
							
								
									
										
										
										
											2017-03-15 09:08:20 +00:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								Other:
							 | 
						
					
						
							
								
									
										
										
										
											2017-08-24 15:33:38 +02:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								* [Why Catch?](why-catch.md#top)
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								* [Open Source Projects using Catch](opensource-users.md#top)
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								* [Contributing](contributing.md#top)
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								* [Release Notes](release-notes.md#top)
							 | 
						
					
						
							
								
									
										
										
										
											2018-11-24 18:01:20 +01:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								* [Deprecations and incoming changes](deprecations.md#top)
							 |