From a6ceae7ef4decd548c302735b395584452834207 Mon Sep 17 00:00:00 2001 From: Timo Heister Date: Wed, 23 Sep 2020 10:49:23 -0400 Subject: [PATCH] doxygen: put subscriptor function into group These functions now appear (see #10914) in each derived class like SparsityPattern. Provide a heading for these functions. --- include/deal.II/base/subscriptor.h | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/include/deal.II/base/subscriptor.h b/include/deal.II/base/subscriptor.h index 363338a1da..7f136b4e0b 100644 --- a/include/deal.II/base/subscriptor.h +++ b/include/deal.II/base/subscriptor.h @@ -102,6 +102,14 @@ public: Subscriptor & operator=(Subscriptor &&) noexcept; + /** + * @name Subscriptor functionality + * + * Classes derived from Subscriptor provide a facility to subscribe to this + * object. This is mostly used by the SmartPointer class. + */ + // @{ + /** * Subscribes a user of the object by storing the pointer @p validity. The * subscriber may be identified by text supplied as @p identifier. @@ -141,6 +149,8 @@ public: void list_subscribers() const; + // @} + /** * @addtogroup Exceptions * @{ -- 2.39.5