summaryrefslogtreecommitdiff
path: root/boost/geometry/iterators/closing_iterator.hpp
diff options
context:
space:
mode:
Diffstat (limited to 'boost/geometry/iterators/closing_iterator.hpp')
-rw-r--r--boost/geometry/iterators/closing_iterator.hpp5
1 files changed, 3 insertions, 2 deletions
diff --git a/boost/geometry/iterators/closing_iterator.hpp b/boost/geometry/iterators/closing_iterator.hpp
index 7cd8fa0150..a9f67d4788 100644
--- a/boost/geometry/iterators/closing_iterator.hpp
+++ b/boost/geometry/iterators/closing_iterator.hpp
@@ -28,8 +28,9 @@ namespace boost { namespace geometry
\brief Iterator which iterates through a range, but adds first element at end of the range
\tparam Range range on which this class is based on
\ingroup iterators
-\note Use with "closing_iterator<Range> or "closing_iterator<Range const>
- to get non-const / const behaviour
+\note It's const iterator treating the Range as one containing non-mutable elements.
+ For both "closing_iterator<Range> and "closing_iterator<Range const>
+ const reference is always returned when dereferenced.
\note This class is normally used from "closeable_view" if Close==true
*/
template <typename Range>