From: Wolfgang Bangerth Date: Sun, 16 Aug 2015 20:52:14 +0000 (-0500) Subject: Rename the UpdateFlagsEssay. X-Git-Tag: v8.4.0-rc2~592^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F1375%2Fhead;p=dealii.git Rename the UpdateFlagsEssay. Since it's a regular @group now, remove the 'Essay' part of the name. --- diff --git a/doc/doxygen/headers/fe.h b/doc/doxygen/headers/fe.h index 8a8b572ac7..46c0ed4b8e 100644 --- a/doc/doxygen/headers/fe.h +++ b/doc/doxygen/headers/fe.h @@ -100,7 +100,7 @@ * * The actual workings of the FEValues class and friends is * complicated because it has to be general yet efficient. The page on - * @ref UpdateFlagsEssay attempts to give an overview of how this + * @ref UpdateFlags attempts to give an overview of how this * works. * * @ingroup feall diff --git a/doc/doxygen/headers/update_flags.h b/doc/doxygen/headers/update_flags.h index c0bf650882..9136e245c1 100644 --- a/doc/doxygen/headers/update_flags.h +++ b/doc/doxygen/headers/update_flags.h @@ -15,7 +15,7 @@ /** - * @defgroup UpdateFlagsEssay The interplay of UpdateFlags, Mapping, and FiniteElement in FEValues + * @defgroup UpdateFlags The interplay of UpdateFlags, Mapping, and FiniteElement in FEValues * *

Introduction

* diff --git a/doc/doxygen/options.dox.in b/doc/doxygen/options.dox.in index 8375cf2b9b..0819620f83 100644 --- a/doc/doxygen/options.dox.in +++ b/doc/doxygen/options.dox.in @@ -79,7 +79,7 @@ FILTER_SOURCE_FILES = YES # and that expands to specific text. For some more transformations, see # the scripts/filter perl script that is run over the header files before # doxygen sees it and that can expand more complex expressions. -ALIASES += dealiiRequiresUpdateFlags{1}="@note For this function to work properly, the underlying FEValues, FEFaceValues, or FESubfaceValues object on which you call it must have computed the information you are requesting. To do so, the \1 flag must be an element of the list of UpdateFlags that you passed to the constructor of this object. See @ref UpdateFlagsEssay for more information." +ALIASES += dealiiRequiresUpdateFlags{1}="@note For this function to work properly, the underlying FEValues, FEFaceValues, or FESubfaceValues object on which you call it must have computed the information you are requesting. To do so, the \1 flag must be an element of the list of UpdateFlags that you passed to the constructor of this object. See @ref UpdateFlags for more information." ALIASES += dealiiOperationIsMultithreaded="@note If deal.II is configured with threads, this operation will run multi-threaded by splitting the work into smaller chunks (assuming there is enough work to make this worthwhile)." diff --git a/include/deal.II/fe/fe_update_flags.h b/include/deal.II/fe/fe_update_flags.h index 206abf8d1f..e9a7f56d90 100644 --- a/include/deal.II/fe/fe_update_flags.h +++ b/include/deal.II/fe/fe_update_flags.h @@ -84,7 +84,7 @@ template class FiniteElement; * * The mechanism by which all this is accomplished is also discussed on the * page on - * @ref UpdateFlagsEssay. + * @ref UpdateFlags. */ enum UpdateFlags { diff --git a/include/deal.II/fe/fe_values.h b/include/deal.II/fe/fe_values.h index 179e007c5c..d49fa36763 100644 --- a/include/deal.II/fe/fe_values.h +++ b/include/deal.II/fe/fe_values.h @@ -1346,7 +1346,7 @@ namespace internal * recommended to give all needed update flags to FEValues. * * The mechanisms by which this class works is also discussed on the page on - * @ref UpdateFlagsEssay. + * @ref UpdateFlags. * * @ingroup feaccess * @author Wolfgang Bangerth, 1998, 2003, Guido Kanschat, 2001 diff --git a/include/deal.II/fe/mapping.h b/include/deal.II/fe/mapping.h index e2dbd34272..2f1ecddcdb 100644 --- a/include/deal.II/fe/mapping.h +++ b/include/deal.II/fe/mapping.h @@ -547,7 +547,7 @@ protected: * instead, from which the determinant can also be computed -- but * this does not take away from the instructiveness of the example.) * - * @see UpdateFlagsEssay + * @see UpdateFlags */ virtual UpdateFlags