From: bangerth <bangerth@0785d39b-7218-0410-832d-ea1e28bc413d>
Date: Sun, 21 Jul 2013 22:56:58 +0000 (+0000)
Subject: Provide the same comments for begin_active/end_active as for the other DoFHandler... 
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=16002fd6478edd9985bf2171a3b23cb5a3e73d0f;p=dealii-svn.git

Provide the same comments for begin_active/end_active as for the other DoFHandler and Triangulation.

git-svn-id: https://svn.dealii.org/trunk@30080 0785d39b-7218-0410-832d-ea1e28bc413d
---

diff --git a/deal.II/include/deal.II/hp/dof_handler.h b/deal.II/include/deal.II/hp/dof_handler.h
index 4d0177fc41..1baba27526 100644
--- a/deal.II/include/deal.II/hp/dof_handler.h
+++ b/deal.II/include/deal.II/hp/dof_handler.h
@@ -315,9 +315,17 @@ namespace hp
     cell_iterator        begin       (const unsigned int level = 0) const;
 
     /**
-    * Iterator to the first active
-    * cell on level @p level.
-    */
+     *  Iterator to the first active cell on level @p level. If the
+     *  given level does not contain any active cells (i.e., all cells
+     *  on this level are further refined, then this function returns
+     *  <code>end_active(level)</code> so that loops of the kind
+     *  @code
+     *    for (cell=dof_handler.begin_active(level); cell!=dof_handler.end_active(level); ++cell)
+     *      ...
+     *  @endcode
+     *  have zero iterations, as may be expected if there are no active
+     *  cells on this level.
+     */
     active_cell_iterator begin_active(const unsigned int level = 0) const;
 
     /**
@@ -339,12 +347,10 @@ namespace hp
     cell_iterator        end (const unsigned int level) const;
 
     /**
-    * Return an active iterator
-    * which is the first iterator
-    * not on level. If @p level is
-    * the last level, then this
-    * returns <tt>end()</tt>.
-    */
+     * Return an active iterator which is the first active iterator not
+     * on the given level. If @p level is the last level, then this
+     * returns <tt>end()</tt>.
+     */
     active_cell_iterator end_active (const unsigned int level) const;
 
     /*@}*/