From: Wolfgang Bangerth Date: Tue, 4 Aug 2015 17:06:35 +0000 (-0500) Subject: Improve the documentation of the IndexSet::add_indices() function. X-Git-Tag: v8.4.0-rc2~684^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F1253%2Fhead;p=dealii.git Improve the documentation of the IndexSet::add_indices() function. --- 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,