From 77d5bf0cb736203cd09944f4469e45aad0ebc1b3 Mon Sep 17 00:00:00 2001
From: Danny Robson <danny@nerdcruft.net>
Date: Fri, 1 Sep 2017 13:36:13 +1000
Subject: [PATCH] iterator: add simple explanation of infix_iterator

---
 iterator.hpp | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/iterator.hpp b/iterator.hpp
index 892ef45c..0d807c87 100644
--- a/iterator.hpp
+++ b/iterator.hpp
@@ -71,6 +71,16 @@ class referencing_iterator {
 
 namespace util {
     ///////////////////////////////////////////////////////////////////////////
+    /// an output iterator that inserts a delimiter between successive
+    /// assignments
+    ///
+    /// very useful for outputting comma seperated lists to an ostream, eg:
+    ///
+    /// std::copy (
+    ///     std::cbegin (container),
+    ///     std::cend   (container),
+    ///     util::infix_iterator<value_type> (os, ", ")
+    /// );
     template <
         typename T,
         class CharT = char,