]> https://gitweb.dealii.org/ - dealii.git/commitdiff
doxygen: put subscriptor function into group 10953/head
authorTimo Heister <timo.heister@gmail.com>
Wed, 23 Sep 2020 14:49:23 +0000 (10:49 -0400)
committerTimo Heister <timo.heister@gmail.com>
Wed, 23 Sep 2020 14:49:50 +0000 (10:49 -0400)
These functions now appear (see #10914) in each derived class like
SparsityPattern. Provide a heading for these functions.

include/deal.II/base/subscriptor.h

index 363338a1da0968cc6f205f54c1cdd9807c49d8de..7f136b4e0bd3ed40c1f810f357a5fd4af33c01bc 100644 (file)
@@ -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
    * @{

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.