From 13615fbbac0767ca45cdadd5ed25b1d524269907 Mon Sep 17 00:00:00 2001 From: Wolfgang Bangerth Date: Tue, 4 Aug 2015 12:06:35 -0500 Subject: [PATCH] Improve the documentation of the IndexSet::add_indices() function. --- include/deal.II/base/index_set.h | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/include/deal.II/base/index_set.h b/include/deal.II/base/index_set.h index 8543b5ef00..0f924844a7 100644 --- a/include/deal.II/base/index_set.h +++ b/include/deal.II/base/index_set.h @@ -149,7 +149,13 @@ public: /** * Add a whole set of indices described by dereferencing every element of - * the the iterator range [begin,end). + * the iterator range [begin,end). + * + * @param[in] begin Iterator to the first element of range of indices + * to be added + * @param[in] end The past-the-end iterator for the range of elements + * to be added. + * @pre The condition begin@<=end needs to be satisfied. */ template void add_indices (const ForwardIterator &begin, -- 2.39.5