From: Wolfgang Bangerth Date: Mon, 11 Aug 2014 21:50:07 +0000 (-0500) Subject: Minor documentation fixes. X-Git-Tag: v8.2.0-rc1~207^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F80%2Fhead;p=dealii.git Minor documentation fixes. --- diff --git a/include/deal.II/grid/tria_iterator.h b/include/deal.II/grid/tria_iterator.h index 51513ba14b..a56ff3e793 100644 --- a/include/deal.II/grid/tria_iterator.h +++ b/include/deal.II/grid/tria_iterator.h @@ -473,72 +473,52 @@ public: /**@name Advancement of iterators*/ /*@{*/ /** - * Prefix ++ operator: ++i. This + * Prefix ++ operator: ++iterator. This * operator advances the iterator to * the next element and returns * a reference to *this. - * - * The next element is next on this - * level if there are more. If the - * present element is the last on - * this level, the first on the - * next level is accessed. This is only - * valid for iterators pointing to cells, - * faces have no level. */ TriaRawIterator &operator ++ (); /** - * Postfix ++ operator: i++. This + * Postfix ++ operator: iterator++. This * operator advances the iterator to * the next element, but * returns an iterator to the element - * priviously pointed to. Since this + * previously pointed to. + * + * Since this operation * involves a temporary and a copy * operation and since an * @p iterator is quite a large * object for a pointer, use the - * prefix operator ++i whenever - * possible, especially in the head + * prefix operator ++iterator whenever + * possible, especially in the header * of for loops - * (for (; i!=end; ++i)) since there + * (for (; iterator!=end; ++iterator)) since there * you normally never need the * returned value. */ TriaRawIterator operator ++ (int); /** - * Prefix @p -- operator: @p --i. This - * operator advances the iterator to + * Prefix @p -- operator: @p --iterator. This + * operator moves the iterator to * the previous element and returns * a reference to *this. - * - * The previous element is previous on - * this level if index>0. If the - * present element is the first on - * this level, the last on the - * previous level is accessed. This is only - * valid for iterators pointing to cells, - * faces have no level. */ TriaRawIterator &operator -- (); /** - * Postfix @p -- operator: @p i--. This - * operator advances the iterator to + * Postfix @p -- operator: @p iterator--. This + * operator moves the iterator to * the previous element, but * returns an iterator to the element - * priviously pointed to. Since this - * involves a temporary and a copy - * operation and since an - * @p iterator is quite a large - * object for a pointer, use the - * prefix operator @p --i whenever - * possible, especially in the head - * of for loops - * (for (; i!=end; --i)) since there - * you normally never need the - * returned value. + * previously pointed to. + * + * The same applies as for the postfix operator++: If possible, + * avoid it by using the prefix operator form to avoid the use + * of a temporary variable. */ TriaRawIterator operator -- (int); /*@}*/