From a19a1bcc85806e27256498f5d532a6d984f88f5d Mon Sep 17 00:00:00 2001 From: Peter Munch Date: Sun, 10 Nov 2019 19:42:51 +0100 Subject: [PATCH] Add missing doxygen comment in ConsensusAlgorithm --- include/deal.II/base/mpi.h | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/include/deal.II/base/mpi.h b/include/deal.II/base/mpi.h index fc03961682..535f60a07e 100644 --- a/include/deal.II/base/mpi.h +++ b/include/deal.II/base/mpi.h @@ -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; -- 2.39.5