From: Wolfgang Bangerth Date: Wed, 28 Apr 2021 16:46:51 +0000 (-0600) Subject: Improve the documentation of the Table classes slightly. X-Git-Tag: v9.3.0-rc1~161^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=6e54e9ba72bfbb34f6591e2757ab97fe10a781d3;p=dealii.git Improve the documentation of the Table classes slightly. --- diff --git a/include/deal.II/base/table.h b/include/deal.II/base/table.h index a5a951b73d..2b24c20e8c 100644 --- a/include/deal.II/base/table.h +++ b/include/deal.II/base/table.h @@ -669,12 +669,9 @@ class Table : public TableBase /** * A class representing a one-dimensional table, i.e. a vector-like class. - * Since the C++ library has a vector class, there is probably not much need - * for this particular class, but since it is so simple to implement on top of - * the template base class, we provide it anyway. - * - * For the rationale of this class, and a description of the interface, see - * the base class. + * The majority of the interface of this class is implemented in the + * TableBase base class. See there for an outline of the rationale for and + * interface of this class. * * @ingroup data */ @@ -1093,12 +1090,13 @@ namespace MatrixTableIterators /** * A class representing a two-dimensional table, i.e. a matrix of objects (not * necessarily only numbers). + * The majority of the interface of this class is implemented in the + * TableBase base class. See there for an outline of the rationale for and + * interface of this class. * - * For the rationale of this class, and a description of the interface, see - * the base class. Since this serves as the base class of the full matrix - * classes in this library, and to keep a minimal compatibility with a - * predecessor class (vector2d), some additional functions are - * provided. + * This class also serves as the base class for the FullMatrix class + * and consequently has a number of functions that are specific to + * matrices and their needs. * * @ingroup data */ @@ -1343,9 +1341,9 @@ protected: /** * A class representing a three-dimensional table of objects (not necessarily * only numbers). - * - * For the rationale of this class, and a description of the interface, see - * the base class. + * The majority of the interface of this class is implemented in the + * TableBase base class.See there for an outline of the rationale for and + * interface of this class. * * @ingroup data */ @@ -1474,9 +1472,9 @@ public: /** * A class representing a four-dimensional table of objects (not necessarily * only numbers). - * - * For the rationale of this class, and a description of the interface, see - * the base class. + * The majority of the interface of this class is implemented in the + * TableBase base class. See there for an outline of the rationale for and + * interface of this class. * * @ingroup data */ @@ -1567,9 +1565,9 @@ public: /** * A class representing a five-dimensional table of objects (not necessarily * only numbers). - * - * For the rationale of this class, and a description of the interface, see - * the base class. + * The majority of the interface of this class is implemented in the + * TableBase base class. See there for an outline of the rationale for and + * interface of this class. * * @ingroup data */ @@ -1663,9 +1661,9 @@ public: /** * A class representing a six-dimensional table of objects (not necessarily * only numbers). - * - * For the rationale of this class, and a description of the interface, see - * the base class. + * The majority of the interface of this class is implemented in the + * TableBase base class. See there for an outline of the rationale for and + * interface of this class. * * @ingroup data */ @@ -1760,9 +1758,9 @@ public: /** * A class representing a seven-dimensional table of objects (not necessarily * only numbers). - * - * For the rationale of this class, and a description of the interface, see - * the base class. + * The majority of the interface of this class is implemented in the + * TableBase base class. See there for an outline of the rationale for and + * interface of this class. * * @ingroup data */