From 63b747ed662150325f170dcb0e0e9781c52ae424 Mon Sep 17 00:00:00 2001 From: Wolfgang Bangerth Date: Fri, 4 Aug 2017 06:08:00 -0600 Subject: [PATCH] Update documentation. --- include/deal.II/grid/tria.h | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/include/deal.II/grid/tria.h b/include/deal.II/grid/tria.h index 70a2927574..85af22bdff 100644 --- a/include/deal.II/grid/tria.h +++ b/include/deal.II/grid/tria.h @@ -1503,7 +1503,28 @@ public: typedef TriaIterator > face_iterator; typedef TriaActiveIterator > active_face_iterator; + /** + * A typedef that defines an iterator type to iterate over + * vertices of a mesh. The concept of iterators is discussed at + * length in the + * @ref Iterators "iterators documentation module". + * + * @ingroup Iterators + */ typedef TriaIterator > vertex_iterator; + + /** + * A typedef that defines an iterator type to iterate over + * vertices of a mesh. The concept of iterators is discussed at + * length in the + * @ref Iterators "iterators documentation module". + * + * This typedef is in fact identical to the @p vertex_iterator typedef + * above since all vertices in a mesh are active (i.e., are a vertex of + * an active cell). + * + * @ingroup Iterators + */ typedef TriaActiveIterator > active_vertex_iterator; typedef typename IteratorSelector::line_iterator line_iterator; -- 2.39.5