diff options
| author | A. Wilcox <AWilcox@Wilcox-Tech.com> | 2019-10-06 19:01:39 -0500 |
|---|---|---|
| committer | A. Wilcox <AWilcox@Wilcox-Tech.com> | 2019-10-06 19:01:39 -0500 |
| commit | 7bcadd4ac91d4694700d9d173233a2b234d1799d (patch) | |
| tree | 1ba884a98e3ef0722ee408a5eb80aa8e6cc046bc /util/output.hh | |
| parent | fb60761c469f3b144e741cef14762a5b6a037112 (diff) | |
| download | horizon-7bcadd4ac91d4694700d9d173233a2b234d1799d.tar.gz horizon-7bcadd4ac91d4694700d9d173233a2b234d1799d.tar.bz2 horizon-7bcadd4ac91d4694700d9d173233a2b234d1799d.tar.xz horizon-7bcadd4ac91d4694700d9d173233a2b234d1799d.zip | |
util: Document reset_if_pretty
Diffstat (limited to 'util/output.hh')
| -rw-r--r-- | util/output.hh | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/util/output.hh b/util/output.hh index f4f939f..fa81127 100644 --- a/util/output.hh +++ b/util/output.hh @@ -34,6 +34,10 @@ inline void colour_if_pretty(bool pretty, std::ostream &stream, if(pretty) stream << "\033[" + what + ";1m"; } +/*! Reset all formatting on +stream+ if +pretty+. + * @param pretty Whether to act. + * @param stream The stream on which to reset formatting. + */ inline void reset_if_pretty(bool pretty, std::ostream &stream) { if(pretty) stream << "\033[0m"; } |