]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Improve the documentation of the IndexSet::add_indices() function. 1253/head
authorWolfgang Bangerth <bangerth@math.tamu.edu>
Tue, 4 Aug 2015 17:06:35 +0000 (12:06 -0500)
committerWolfgang Bangerth <bangerth@math.tamu.edu>
Tue, 4 Aug 2015 17:35:25 +0000 (12:35 -0500)
include/deal.II/base/index_set.h

index 8543b5ef0003cfe21275e0b6e963e0adbec2ff9d..0f924844a712f3b7749ca3fd17e8d1a4e3fff5ef 100644 (file)
@@ -149,7 +149,13 @@ public:
 
   /**
    * Add a whole set of indices described by dereferencing every element of
-   * the the iterator range <code>[begin,end)</code>.
+   * the iterator range <code>[begin,end)</code>.
+   *
+   * @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 <code>begin@<=end</code> needs to be satisfied.
    */
   template <typename ForwardIterator>
   void add_indices (const ForwardIterator &begin,

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.