From 7bcadd4ac91d4694700d9d173233a2b234d1799d Mon Sep 17 00:00:00 2001
From: "A. Wilcox" <AWilcox@Wilcox-Tech.com>
Date: Sun, 6 Oct 2019 19:01:39 -0500
Subject: util: Document reset_if_pretty

---
 util/output.hh | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'util/output.hh')

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";
 }
-- 
cgit v1.2.3-60-g2f50