From: Timo Heister Date: Wed, 23 Sep 2020 14:49:23 +0000 (-0400) Subject: doxygen: put subscriptor function into group X-Git-Tag: v9.3.0-rc1~1070^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F10953%2Fhead;p=dealii.git doxygen: put subscriptor function into group These functions now appear (see #10914) in each derived class like SparsityPattern. Provide a heading for these functions. --- 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 * @{