From 6818d961008f60291e93f2517123c431e0808861 Mon Sep 17 00:00:00 2001 From: Wolfgang Bangerth Date: Wed, 24 Apr 2019 14:39:31 -0600 Subject: [PATCH] Augment documentation in class IteratorRange. --- include/deal.II/base/iterator_range.h | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/include/deal.II/base/iterator_range.h b/include/deal.II/base/iterator_range.h index cf09a4f6e7..009067ed81 100644 --- a/include/deal.II/base/iterator_range.h +++ b/include/deal.II/base/iterator_range.h @@ -33,7 +33,8 @@ DEAL_II_NAMESPACE_OPEN * * The purpose of this class is so that classes such as Triangulation and * DoFHandler can return ranges of cell iterators using an object of the - * current type from functions such as Triangulation::cells() and that such an + * current type from functions such as + * Triangulation::cell_iterators() and that such an * object can then be used in a range-based for loop as supported by C++11, * see also * @ref CPP11 "C++11 standard". @@ -75,11 +76,13 @@ DEAL_II_NAMESPACE_OPEN * statement; * } * @endcode + * (The precise definition can be found here: + * https://en.cppreference.com/w/cpp/language/range-for .) * In other words, the compiler introduces a temporary variable that * iterates over the elements of the container or collection, and the * original variable v that appeared in the range-based for loop - * represents the dereferenced state of these iterators -- in other - * words, the elements of the collection. + * represents the dereferenced state of these iterators -- namely, + * the elements of the collection. * * In the context of loops over cells, we typically want to retain the fact * that the loop variable is an iterator, not a value. This is because in -- 2.39.5