From: bangerth <bangerth@0785d39b-7218-0410-832d-ea1e28bc413d>
Date: Sat, 18 Dec 2010 03:19:35 +0000 (+0000)
Subject: Add documentation for the new vertex iterator (a.k.a. DoFAccessor<0,DH<1,spacedim... 
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=37a23350f7ecc174ecaf0a0690bf1ee0430cba4f;p=dealii-svn.git

Add documentation for the new vertex iterator (a.k.a. DoFAccessor<0,DH<1,spacedim> >).


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

diff --git a/deal.II/include/deal.II/dofs/dof_accessor.h b/deal.II/include/deal.II/dofs/dof_accessor.h
index 494e47fc08..b74f47048e 100644
--- a/deal.II/include/deal.II/dofs/dof_accessor.h
+++ b/deal.II/include/deal.II/dofs/dof_accessor.h
@@ -757,6 +757,16 @@ class DoFAccessor : public internal::DoFAccessor::Inheritance<structdim, DH::dim
 
 
 
+/**
+ * Specialization of the general DoFAccessor class template for the
+ * case of zero-dimensional objects (a vertex) that are the face of a
+ * one-dimensional cell in spacedim space dimensions. Since vertices
+ * function differently than general faces, this class does a few
+ * things differently than the general template, but the interface
+ * should look the same.
+ *
+ * @author Wolfgang Bangerth, 2010
+ */
 template <template <int, int> class DH, int spacedim>
 class DoFAccessor<0,DH<1,spacedim> > : public TriaAccessor<0,1,spacedim>
 {