From ffb28eaa1e15f85d3fbf6bfc3a04a4010f9c80c9 Mon Sep 17 00:00:00 2001
From: regnat <rg@regnat.ovh>
Date: Mon, 24 Jan 2022 10:07:02 +0100
Subject: Add a small documentation for `hiliteMatches`

---
 src/libutil/fmt.hh | 7 +++++++
 1 file changed, 7 insertions(+)

(limited to 'src')

diff --git a/src/libutil/fmt.hh b/src/libutil/fmt.hh
index 06c4a2049..1f81bfcfb 100644
--- a/src/libutil/fmt.hh
+++ b/src/libutil/fmt.hh
@@ -156,5 +156,12 @@ inline hintformat hintfmt(std::string plain_string)
     return hintfmt("%s", normaltxt(plain_string));
 }
 
+/**
+ * Highlight all the given matches in the given string `s` by wrapping them
+ * between `prefix` and `postfix`.
+ *
+ * If some matches overlap, then their union will be wrapped rather than the
+ * individual matches.
+ */
 std::string hiliteMatches(const std::string &s, std::vector<std::smatch> matches, std::string prefix, std::string postfix);
 }
-- 
cgit v1.2.3