Read-only mirrors. Development, issues and pull requests are on GitHub.

summaryrefslogtreecommitdiffhomepage
path: root/src/catch2
diff options
context:
space:
mode:
authorMartin Hořeňovský2022-04-07 12:40:46 +0200
committerMartin Hořeňovský2022-04-07 12:50:18 +0200
commit46b3f7ee5fa29c65e786abb180df15fff68ef1c1 (patch)
tree7bf5515b8fbb8465d19b93a5f657e8cb7e70f9da /src/catch2
parentf9f4e58dfbec1da8fee63383d72e07d2fab87eb7 (diff)
downloadcatch3-46b3f7ee5fa29c65e786abb180df15fff68ef1c1.tar.gz
Document magic %-prefixed streams
Diffstat (limited to 'src/catch2')
-rw-r--r--src/catch2/internal/catch_stream.hpp11
1 files changed, 11 insertions, 0 deletions
diff --git a/src/catch2/internal/catch_stream.hpp b/src/catch2/internal/catch_stream.hpp
index ba0a3876..41c1fef0 100644
--- a/src/catch2/internal/catch_stream.hpp
+++ b/src/catch2/internal/catch_stream.hpp
@@ -40,6 +40,17 @@ namespace Catch {
virtual bool isConsole() const { return false; }
};
+ /**
+ * Creates a stream wrapper that writes to specific file.
+ *
+ * Also recognizes 4 special filenames
+ * * `-` for stdout
+ * * `%stdout` for stdout
+ * * `%stderr` for stderr
+ * * `%debug` for platform specific debugging output
+ *
+ * \throws if passed an unrecognized %-prefixed stream
+ */
auto makeStream( std::string const& filename ) -> Detail::unique_ptr<IStream const>;
class ReusableStringStream : Detail::NonCopyable {