Updated documentation TOCs

This commit is contained in:
Martin Moene 2018-09-05 10:01:54 +02:00 committed by Martin Hořeňovský
parent 60b05b2041
commit a81c01d4f9
6 changed files with 38 additions and 1 deletions

View File

@ -1,6 +1,12 @@
<a id="top"></a> <a id="top"></a>
# CI and other odd pieces # CI and other odd pieces
**Contents**<br>
[Continuous Integration systems](#continuous-integration-systems)<br>
[Other reporters](#other-reporters)<br>
[Low-level tools](#low-level-tools)<br>
[CMake](#cmake)<br>
This page talks about how Catch integrates with Continuous Integration This page talks about how Catch integrates with Continuous Integration
Build Systems may refer to low-level tools, like CMake, or larger systems that run on servers, like Jenkins or TeamCity. This page will talk about both. Build Systems may refer to low-level tools, like CMake, or larger systems that run on servers, like Jenkins or TeamCity. This page will talk about both.

View File

@ -24,7 +24,7 @@
[Usage](#usage)<br> [Usage](#usage)<br>
[Specify the section to run](#specify-the-section-to-run)<br> [Specify the section to run](#specify-the-section-to-run)<br>
[Filenames as tags](#filenames-as-tags)<br> [Filenames as tags](#filenames-as-tags)<br>
[Override output colouring](#use-colour)<br> [Override output colouring](#override-output-colouring)<br>
Catch works quite nicely without any command line options at all - but for those times when you want greater control the following options are available. Catch works quite nicely without any command line options at all - but for those times when you want greater control the following options are available.
Click one of the followings links to take you straight to that option - or scroll on to browse the available options. Click one of the followings links to take you straight to that option - or scroll on to browse the available options.

View File

@ -9,9 +9,12 @@
[stdout](#stdout)<br> [stdout](#stdout)<br>
[Fallback stringifier](#fallback-stringifier)<br> [Fallback stringifier](#fallback-stringifier)<br>
[Default reporter](#default-reporter)<br> [Default reporter](#default-reporter)<br>
[C++11 toggles](#c-11-toggles)<br>
[C++17 toggles](#c-17-toggles)<br>
[Other toggles](#other-toggles)<br> [Other toggles](#other-toggles)<br>
[Windows header clutter](#windows-header-clutter)<br> [Windows header clutter](#windows-header-clutter)<br>
[Enabling stringification](#enabling-stringification)<br> [Enabling stringification](#enabling-stringification)<br>
[Disabling exceptions](#disabling-exceptions)<br>
Catch is designed to "just work" as much as possible. For most people the only configuration needed is telling Catch which source file should host all the implementation code (```CATCH_CONFIG_MAIN```). Catch is designed to "just work" as much as possible. For most people the only configuration needed is telling Catch which source file should host all the implementation code (```CATCH_CONFIG_MAIN```).

View File

@ -1,6 +1,12 @@
<a id="top"></a> <a id="top"></a>
# Supplying main() yourself # Supplying main() yourself
**Contents**<br>
[Let Catch take full control of args and config](#let-catch-take-full-control-of-args-and-config)<br>
[Amending the config](#amending-the-config)<br>
[Adding your own command line options](#adding-your-own-command-line-options)<br>
[Version detection](#version-detection)<br>
The easiest way to use Catch is to let it supply ```main()``` for you and handle configuring itself from the command line. The easiest way to use Catch is to let it supply ```main()``` for you and handle configuring itself from the command line.
This is achieved by writing ```#define CATCH_CONFIG_MAIN``` before the ```#include "catch.hpp"``` in *exactly one* source file. This is achieved by writing ```#define CATCH_CONFIG_MAIN``` before the ```#include "catch.hpp"``` in *exactly one* source file.

View File

@ -1,5 +1,21 @@
<a id="top"></a> <a id="top"></a>
# Release notes
**Contents**<br>
[2.4.0](#240)<br>
[2.3.0](#230)<br>
[2.2.3](#223)<br>
[2.2.2](#222)<br>
[2.2.1](#221)<br>
[2.2.0](#220)<br>
[2.1.2](#212)<br>
[2.1.1](#211)<br>
[2.1.0](#210)<br>
[2.0.1](#201)<br>
[Older versions](#older-versions)<br>
[Even Older versions](#even-older-versions)<br>
# 2.4.0 # 2.4.0
**This release brings two new experimental features, generator support **This release brings two new experimental features, generator support

View File

@ -1,6 +1,12 @@
<a id="top"></a> <a id="top"></a>
# String conversions # String conversions
**Contents**<br>
[operator << overload for std::ostream](#operator-overload-for-std-ostream)<br>
[Catch::StringMaker<T> specialisation](#catch-stringmaker-t-specialisation)<br>
[Catch::is_range<T> specialisation](#catch-is_range-t-specialisation)<br>
[Exceptions](#exceptions)<br>
Catch needs to be able to convert types you use in assertions and logging expressions into strings (for logging and reporting purposes). Catch needs to be able to convert types you use in assertions and logging expressions into strings (for logging and reporting purposes).
Most built-in or std types are supported out of the box but there are two ways that you can tell Catch how to convert your own types (or other, third-party types) into strings. Most built-in or std types are supported out of the box but there are two ways that you can tell Catch how to convert your own types (or other, third-party types) into strings.