Commit Graph

305 Commits

Author SHA1 Message Date
Martin Hořeňovský
cfaf906417 Changed documentation to use standard main function signature 2017-01-19 17:05:01 +01:00
Martin Hořeňovský
2e87f8e328 Merge branch 'windows-header-defines' of https://github.com/horenmar/Catch 2017-01-16 17:00:43 +01:00
Martin Hořeňovský
b3907a78e1 Added NOMINMAX and WIN32_LEAN_AND_MEAN defines before including windows.h
This stops the `windows.h` header from defining `min` and `max` macros
and including lot of Windows APIs that are not needed by Catch.
2017-01-12 16:00:02 +01:00
Phil Nash
e6aa1f4e4e Added note on escaping names on command line to docs 2017-01-11 17:14:28 +00:00
Phil Nash
1ff0acfe22 Tweaked release notes page with better formatting 2017-01-11 16:50:35 +00:00
Phil Nash
713ec400e8 Fixed type in “Release Notes” link 2017-01-11 16:46:09 +00:00
Phil Nash
3b2f206191 v1.6.0 build - including release notes 2017-01-11 16:44:36 +00:00
Martin Hořeňovský
737f4ea77c Added missing C++11 feature toggle to docs 2017-01-10 22:43:58 +01:00
Phil Nash
b0de6c938a Updated docs for contributing 2017-01-10 07:36:06 +00:00
Kylo Ginsberg
10c44847f4 Make backticks symmetric in markdown 2017-01-09 18:03:40 +01:00
Antoine Wendlinger
8d326424f3 Minor typo fix 2017-01-07 22:05:18 +01:00
Eldar Zakirov
ccc34b63b6 URL fixed 2017-01-07 14:51:13 +01:00
faulda
e273a3dc88 Fix grammar error in tutorial.md
It's = it is
In the sentence "In fact it is usually a good idea to put the block with the ```#define``` [in it's own source file](slow-compiles.md).", the correct usage is "its", not "it's".
2017-01-07 09:56:21 +01:00
Victor
7bff9cb451 own-main.md: fix typo 2017-01-07 09:55:27 +01:00
andrew morton
fd1da4a1d1 Fixing a couple of typos
I tried to make sure I wasn't changing any British spellings so I apologize
if I've mixed any up.
2017-01-07 09:45:38 +01:00
Rafael Eyng
7544644bb4 Update tutorial.md
Closes #633
2016-04-04 23:04:45 -03:00
Trevor Hickey
e52ad48fb7 removes link to missing readme file 2016-02-26 10:29:23 -05:00
Phil Nash
3bd20bf2cd Removed reference to pre 1.0 release from README 2016-01-22 07:59:06 +00:00
Phil Nash
a49f088032 exception translators considered even for types deriving from std::exception, now
- also added docs for exception translators
- updated approvals
2015-11-18 08:39:21 +00:00
Phil Nash
b3b2352045 Fixed some missing sentence structure
Thanks to #517
2015-10-19 09:16:16 +01:00
Phil Nash
40d0d2f656 Added unique_ptr detection to compiler_capabilities
- as well as use by C++11 conformant compilers now enabled for VS2013 on too (see #479)
- updated docs with this (and long long and override support)
2015-08-11 08:09:41 +01:00
Phil Nash
02e1966db3 Changed --filenames-as-tags prefix to #, added -# as short form and updated docs 2015-07-06 18:46:50 +01:00
Phil Nash
7ab3b5aefb Added compiler feature suppression macros
_NO_ forms to disable detection of features - particularly C++11 features.
Also removed SFINAE detection (and use in tostring)
2015-06-30 08:41:55 +01:00
Phil Nash
21f7ef6fdc Committed to semantic versioning
as prompted by #365, #430, #447 and a thread on the google group.
- split version bumping out of generateSingleHeader script
- separate scripts for bumping each version component
- "build" number only incremented for "develop" builds
2015-06-29 18:06:15 +01:00
Phil Nash
bdbfe69e3c Merge branch 'master' of github.com:philsquared/Catch 2015-05-20 18:13:15 +01:00
Phil Nash
605d870384 Updated toString docs with StringMaker 2015-05-20 18:12:40 +01:00
Phil Nash
a55c1cfb97 Merge pull request #380 from socantre/master
s/ran/run
2015-05-20 06:27:00 +01:00
Phil Nash
e86daf8bdd Reorganised C+11 feature detection a bit
and added CATCH_CONFIG_CPP11_NULLPTR for VS2015
2015-05-19 22:31:57 +01:00
Phil Nash
2946c1988c Added comments on multi-file tests to tutorial
Prompted by PR #397 (and a lot of support history!) - added some comments on how to move beyond "everything in a single file"
2015-05-18 18:40:58 +01:00
Nikolaus Wittenstein
65953871fc Fix typo in tutorial.md 2015-04-20 19:49:40 -04:00
Phil Nash
35f4266d00 Merge branch 'develop' 2015-03-27 20:49:32 +00:00
Phil Nash
4af4405ce1 Fixed a missing ), as per PR #363 and PR #390 2015-03-27 18:23:02 +00:00
Phil Nash
d9fbc62093 Merged from develop 2015-03-27 17:54:45 +00:00
socantre
dd460f0085 s/ran/run 2015-03-07 16:09:36 -05:00
Phil Nash
b9ec8a10ed Merge pull request #344 from therocode/patch-1
Update test-fixtures.md
2014-12-30 18:36:27 +00:00
Phil Nash
1cbc4f2c9c Merge branch 'develop' of https://github.com/SeanCline/Catch into develop 2014-12-23 18:54:08 +00:00
Phil Nash
acf638f2bc Added docs for floating point comparisons 2014-12-17 18:45:50 +00:00
Phil Nash
b454c43dea Extends configuration docs 2014-12-17 18:16:24 +00:00
Phil Nash
7abc9fa8b7 Added docs for --invisibles
also reordered command line docs jump list to match order listed when getting usage from Catch itself.
2014-12-16 18:38:40 +00:00
Phil Nash
f5c9859131 Try again to fix --order docs 2014-12-16 18:21:42 +00:00
Phil Nash
0b1fa6a080 fixed (hopefully) formatting of '--order' docs
if only there was a standard-markdown!
2014-12-16 18:19:28 +00:00
Phil Nash
840b99af92 Added docs for --input-file
(somehow missing from previous commit)
2014-12-16 18:13:29 +00:00
Phil Nash
5259b78fea Updated command line docs
Added docs for:
  -f, --input-file
  --list-test-names-only
  --order
  --rng-seed
2014-12-16 18:11:13 +00:00
Phil Nash
7e1f21b334 tweaks to tutorial 2014-12-15 07:25:54 +00:00
Phil Nash
30888f59bf removed spurious } 2014-12-12 08:33:10 +00:00
Phil Nash
82754c1766 tweaked formatting 2014-12-12 08:29:21 +00:00
Phil Nash
c6d9bde04e fixed case of tostring.md link 2014-12-09 22:58:28 +00:00
Phil Nash
15a8bdf45b Added string conversions link 2014-12-09 19:15:49 +00:00
Phil Nash
27ce70c96b Added documentation for toString 2014-12-09 18:54:35 +00:00
Phil Nash
32186db1b0 Added first cut of docs for configuring Catch
- initially just covers new colour config
- also updated all [Home] links in footers to go to local readme
2014-10-21 18:25:57 +01:00
Tobias Widlund
e26e1567c8 Update test-fixtures.md
Fix a small type
2014-10-13 16:37:03 +02:00
Anthony Super
c9746634c4 Documentation Changes
Modified several sentences for clarity and fixed a few typos.
2014-09-12 17:12:43 -06:00
Andy Balaam
389f3f5be8 Fix a typo (missing "n") 2014-08-22 15:18:33 +01:00
Phil Nash
4f4b44e3a2 Merge branch 'develop' of github.com:philsquared/Catch
Tweaked wording around ability to do BDD
2014-08-21 07:25:27 +01:00
Phil Nash
b3ece7e75d Tweaked wording around ability to do BDD 2014-08-21 07:22:35 +01:00
Phil Nash
76edbc104c Updated “contributing” docs to reflect new develop branch 2014-08-20 19:03:31 +01:00
Martin Moene
3e025cc2b6 Added bundled compact reporter 2014-08-19 23:43:51 +02:00
Phil Nash
bcbd0cbbc2 Merge pull request #302 from johannesmoene/doc-index
Add Readme as documentation entry
2014-08-19 07:44:34 +01:00
Martin Moene
e35f862653 Fixed link to blog post 2014-08-19 07:34:00 +02:00
Martin Moene
d59fd53e7e Update link in tutorial 2014-08-15 14:30:38 +02:00
Martin Moene
6336bb1b6e Add Readme as documentation entry 2014-08-15 14:12:53 +02:00
Phil Nash
08dc8458c0 Updated docs on slow compiles 2014-07-30 19:06:26 +01:00
Phil Nash
6880a0c909 Added FAQ on slow compiles to docs 2014-07-21 19:00:02 +01:00
Alex Moreno
c6022381f5 Fixed typo 2014-06-11 15:17:17 +08:00
Phil Nash
44aa45cc4f Merge pull request #283 from lichray/patch-1
fix macro syntax in doc
2014-06-02 08:02:03 +01:00
Phil Nash
7f1156d477 Fixed typo 2014-05-29 17:10:38 +01:00
Zhihao Yuan
a9cd3a0ef8 fix macro syntax in doc 2014-05-28 18:27:34 -04:00
Joseph Schrag
d8bde3e847 Fixed Typo 2014-05-22 16:13:42 -06:00
Phil Nash
463f7bdf65 Merge pull request #260 from paleozogt/patch-1
GIT_EXECUTABLE undefined
2014-04-18 18:33:46 +01:00
Phil Nash
3c34d65b5c Doc tweaks 2014-04-16 08:18:06 +01:00
Phil Nash
94f47d5f8c Updated docs with new [!throws] behaviour 2014-04-16 07:58:09 +01:00
Aaron Simmons
72e96d9d04 GIT_EXECUTABLE undefined
This script needs to find_package for git so that GIT_EXECUTABLE is defined.
2014-03-17 14:39:34 -06:00
David Beckley
e6ee29a925 Highlight block as C++
C++ syntax highlighting was not enabled on one of the blocks.
2014-03-05 16:46:20 -08:00
gnzlbg
69a921f2d6 Add documentation for the CMake build system
- new file "docs/build-system.md" to document the integration of
  Catch with popular build systems.
- document how to configure Catch as a CMake external project.
2013-11-21 14:15:09 +01:00
Phil Nash
f15b74c0d2 Added some more docs 2013-11-14 19:08:19 +00:00
Phil Nash
11ba377134 Change one more in-page link to work with GitHub generated anchors 2013-11-09 07:43:20 +00:00
Phil Nash
d17bb40030 Converted all html anchors in command line docs to match github generated anchors 2013-11-07 13:38:48 +00:00
Phil Nash
6916298c22 Attempt to match html anchors (which github strips out) with the ones github generates. 2013-11-07 13:30:39 +00:00
Phil Nash
0d4894e4bf Updated command line docs with -w and -d 2013-11-07 10:35:40 +00:00
Phil Nash
d0e7b628b7 Fixed typo 2013-10-18 17:50:22 +01:00
Phil Nash
f4959e7699 First commit of docs for contributors 2013-10-18 07:52:38 +01:00
Phil Nash
bdb718471f Fixed typo 2013-10-17 22:45:37 +01:00
Phil Nash
34266b6e0f more doc formatting fixes 2013-10-02 08:17:46 +01:00
Phil Nash
b9c6d30631 minor doc tweaks 2013-10-02 07:58:15 +01:00
Phil Nash
716a3a0285 escaped square brackets 2013-10-02 07:55:01 +01:00
Phil Nash
76ef79a990 Expanded test-cases-and-exceptions docs and added to reference-index 2013-10-01 19:07:09 +01:00
Phil Nash
4ab680a4fb Expanded docs on tests cases and sections (still work-in-progress)
- also touched up some outdated bits in the tutorial
2013-10-01 08:20:08 +01:00
Phil Nash
dea43e0b76 Merge pull request #180 from benjamg/patch-1
Fix external site links
2013-07-03 00:15:44 -07:00
Phil Nash
54e6f9d471 Slightly tweaked docs on supplying your own main 2013-07-02 19:42:21 +01:00
Ben Gray
27a4d7a484 Fix external site links
The links (for me under firefox/ubunutu at least) try to open files in github rather than the catch-lib site.
2013-06-30 13:20:43 +01:00
Phil Nash
f987da4411 Update whats-changed.md 2013-06-28 18:19:19 +01:00
Phil Nash
54c8817e53 Update whats-changed.md 2013-06-28 18:19:06 +01:00
Phil Nash
7bd033c829 Update whats-changed.md 2013-06-28 18:18:46 +01:00
Phil Nash
c22cfc4a95 Addd test-fixtures docs from wiki 2013-06-28 17:45:08 +01:00
Phil Nash
d60b248409 Updated docs with INFO/ CAPTURE changes 2013-06-28 17:15:45 +01:00
Phil Nash
881c61b67f Updated docs to reflect INFO change 2013-06-28 16:27:53 +01:00
Phil Nash
ae1c1ac1a0 Added "what's changed" 2013-06-25 13:21:41 +01:00
Phil Nash
1d3dd71774 Fixed returns in docs ref 2013-06-14 08:41:59 +01:00
Phil Nash
a26ddc9ca7 New docs for command line and logging 2013-06-14 08:32:48 +01:00
Phil Nash
fd1cd7820d Completed assertions docs 2013-06-10 08:18:26 +01:00
Phil Nash
46953c8319 Filled out reference index and added placeholders for assertions and logging docs 2013-06-10 08:08:20 +01:00
Phil Nash
d07cd3353f Added new docs for supplying your own main. 2013-06-07 23:06:54 +01:00
Phil Nash
0ec7ea2e49 Doc updates 2013-06-07 21:31:28 +01:00
Phil Nash
f3592f2102 Docs progress 2013-06-07 19:09:38 +01:00
Phil Nash
4e88ccda56 Start of new docs 2013-06-03 20:03:07 +01:00