From: Wolfgang Bangerth Date: Wed, 13 Sep 2017 18:45:49 +0000 (-0600) Subject: Update some documentation. X-Git-Tag: v9.0.0-rc1~1078^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=0421b7fdec77d4de37410c7f965861d44293c03f;p=dealii.git Update some documentation. --- diff --git a/include/deal.II/grid/tria_accessor.h b/include/deal.II/grid/tria_accessor.h index c680fe72a8..d45031260f 100644 --- a/include/deal.II/grid/tria_accessor.h +++ b/include/deal.II/grid/tria_accessor.h @@ -479,12 +479,13 @@ private: * create objects (it will in fact throw an exception if this should ever be * attempted but it sometimes allows code to be written in a simpler way in a * dimension independent way. For example, it allows to write code that works - * on quad iterators that is dimension independent because quad iterators - * (with the current class) exist and are syntactically correct. You can not - * expect, however, to ever generate one of these iterators, meaning you need - * to expect to wrap the code block in which you use quad iterators into - * something like if (dim@>1) -- which makes eminent sense - * anyway. + * on quad iterators that is dimension independent -- i.e., also compiles + * in 1d -- because quad iterators + * (via the current class) exist and are syntactically correct. You can not + * expect, however, to ever create an actual object of one of these iterators + * in 1d, meaning you need to expect to wrap the code block in which you use + * quad iterators into something like if (dim@>1) -- which makes + * eminent sense anyway. * * This class provides the minimal interface necessary for Accessor classes to * interact with Iterator classes. However, this is only for syntactic @@ -503,11 +504,11 @@ public: typedef typename TriaAccessorBase::AccessorData AccessorData; /** - * Constructor. This class is used for iterators that make sense in a given - * dimension, for example quads for 1d meshes. Consequently, while the - * creation of such objects is syntactically valid, they make no semantic - * sense, and we generate an exception when such an object is actually - * generated. + * Constructor. This class is used for iterators that do not make + * sense in a given dimension, for example quads for 1d meshes. Consequently, + * while the creation of such objects is syntactically valid, they make no + * semantic sense, and we generate an exception when such an object is + * actually generated. */ InvalidAccessor (const Triangulation *parent = 0, const int level = -1, @@ -515,11 +516,11 @@ public: const AccessorData *local_data = 0); /** - * Copy constructor. This class is used for iterators that make sense in a - * given dimension, for example quads for 1d meshes. Consequently, while the - * creation of such objects is syntactically valid, they make no semantic - * sense, and we generate an exception when such an object is actually - * generated. + * Copy constructor. This class is used for iterators that do not make + * sense in a given dimension, for example quads for 1d meshes. Consequently, + * while the creation of such objects is syntactically valid, they make no + * semantic sense, and we generate an exception when such an object is + * actually generated. */ InvalidAccessor (const InvalidAccessor &);