]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Add missing doxygen comment in ConsensusAlgorithm 9035/head
authorPeter Munch <peterrmuench@gmail.com>
Sun, 10 Nov 2019 18:42:51 +0000 (19:42 +0100)
committerPeter Munch <peterrmuench@gmail.com>
Sun, 10 Nov 2019 18:42:51 +0000 (19:42 +0100)
include/deal.II/base/mpi.h

index fc039616827edb765a1e13ee5fd9775cde95c2b2..535f60a07e7abd5d1bb05a547d551132d7a3dac6 100644 (file)
@@ -1068,6 +1068,9 @@ namespace Utilities
        */
       virtual ~ConsensusAlgorithm() = default;
 
+      /**
+       * Run consensus algorithm.
+       */
       virtual void
       run() = 0;
 
@@ -1133,7 +1136,7 @@ namespace Utilities
       virtual ~ConsensusAlgorithm_NBX() = default;
 
       /**
-       * Run consensus algorithm.
+       * @copydoc ConsensusAlgorithm::run()
        */
       virtual void
       run() override;
@@ -1275,7 +1278,7 @@ namespace Utilities
       virtual ~ConsensusAlgorithm_PEX() = default;
 
       /**
-       * Run consensus algorithm.
+       * @copydoc ConsensusAlgorithm::run()
        */
       virtual void
       run() override;
@@ -1374,8 +1377,9 @@ namespace Utilities
       virtual ~ConsensusAlgorithmSelector() = default;
 
       /**
-       * Run consensus algorithm. The function call is delegated to another
-       * ConsensusAlgorithm implementation.
+       * @copydoc ConsensusAlgorithm::run()
+       *
+       * @note The function call is delegated to another ConsensusAlgorithm implementation.
        */
       virtual void
       run() override;

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.