maddiebusig/mtl
1
0
Fork 0
Code Issues 6 Pull Requests Packages Projects Releases Wiki Activity

Add additional documentation for log

Browse Source
This commit is contained in:
Myles Busig 2024-06-19 19:32:46 -06:00
parent 1738dd9f63
commit ed2610d60f
1 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
include/mtl/log.hpp
View File

@ -24,18 +24,23 @@ constexpr char endl_char = '\n';
/** /**
* \brief Log stream * \brief Log stream
* *
* String stream that overrides sync() to flush the stream to the correct * String stream that overrides flush() to flush the stream to the correct
* output depending on the platform. Each flush is treated as a separate message. * output depending on the platform. Each flush is treated as a separate message.
* The capacity of the stream depends on the platform. *
* Different streams may share a buffer, so writing to a different stream
* without flushing the previous may cause strange behaviour.
*
* The capacity of the stream depends on the platform, but will always be at
* least 255 characters.
* *
* See mtl::basic_string_stream for information on when the stream is flushed. * See mtl::basic_string_stream for information on when the stream is flushed.
* *
* Platform specific info: * Platform specific info:
* *
* GBA: Flushing cannot be done without printing to a new line. Trying to * GBA: Flushing cannot be done without printing to a new line. Trying to
* insert a newline will instead just flush the stream onto a new line. On MGBA * flush without using mtl::endl will still flush the stream onto a new line.
* this also starts the line with "GBA Debug: ", so the line is not completely * On MGBA this also starts the line with "GBA Debug: ",so the line is not
* blank. * completely blank either.
*/ */
class stream : public basic_string_stream<false, endl_char> { class stream : public basic_string_stream<false, endl_char> {
private: private: