From 8b768ddcfea8eb3d4b149358ad2deecaaf451075 Mon Sep 17 00:00:00 2001 From: Wolfgang Bangerth Date: Tue, 21 Jan 2020 16:44:36 -0700 Subject: [PATCH] Add a note to two .h files about the design pattern used there. --- include/deal.II/fe/fe_values.h | 6 +++++- include/deal.II/numerics/data_out_dof_data.h | 4 ++++ 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/include/deal.II/fe/fe_values.h b/include/deal.II/fe/fe_values.h index b207d80863..7d377fdc18 100644 --- a/include/deal.II/fe/fe_values.h +++ b/include/deal.II/fe/fe_values.h @@ -3307,7 +3307,7 @@ public: protected: /** - * Objects of the FEValues class need to store a pointer (i.e. an iterator) + * Objects of the FEValues class need to store an iterator * to the present cell in order to be able to extract the values of the * degrees of freedom on this cell in the get_function_values() and assorted * functions. On the other hand, this class should also work for different @@ -3332,6 +3332,10 @@ protected: * This way, the use of virtual functions is restricted to only this class, * and other users of iterators do not have to bear the negative effects. * + * @note This class is an example of the + * type + * erasure design pattern. + * * @author Wolfgang Bangerth, 2003 */ class CellIteratorBase; diff --git a/include/deal.II/numerics/data_out_dof_data.h b/include/deal.II/numerics/data_out_dof_data.h index a8c3cc8fc5..44a5686709 100644 --- a/include/deal.II/numerics/data_out_dof_data.h +++ b/include/deal.II/numerics/data_out_dof_data.h @@ -211,6 +211,10 @@ namespace internal * Since the vectors all have the same interface, this is no big problem, * as they can all use the same general templatized code. * + * @note This class is an example of the + * type + * erasure design pattern. + * * @author Wolfgang Bangerth, 2004 */ template -- 2.39.5