From: Daniel Arndt Date: Tue, 20 Mar 2018 17:07:16 +0000 (+0100) Subject: Fix documentation of Utilities::MPI::MinMaxAvg X-Git-Tag: v9.0.0-rc1~298^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=e7b2990e94afef306b7787126e48387c1e6dd086;p=dealii.git Fix documentation of Utilities::MPI::MinMaxAvg --- diff --git a/include/deal.II/base/mpi.h b/include/deal.II/base/mpi.h index 2dd20725c3..fa06d97656 100644 --- a/include/deal.II/base/mpi.h +++ b/include/deal.II/base/mpi.h @@ -314,19 +314,34 @@ namespace Utilities { /** * The sum over all values contributed by the processors that - * participate in the call to min_max_avg(), as well as the - * minimum and maximum value. + * participate in the call to min_max_avg(). */ double sum; + + /** + * The minimum value over all values contributed by the processors that + * participate in the call to min_max_avg(). + */ double min; + + /** + * The maximum value over all values contributed by the processors that + * participate in the call to min_max_avg(). + */ double max; /** - * The indices (i.e., @ref GlossMPIRank "MPI rank" within an + * One of the ranks (i.e., @ref GlossMPIRank "MPI rank" within an * @ref GlossMPICommunicator "MPI communicator") of the - * processors that hold the minimal and maximal values. + * processors that hold the minimal value. */ unsigned int min_index; + + /** + * One of the ranks (i.e., @ref GlossMPIRank "MPI rank" within an + * @ref GlossMPICommunicator "MPI communicator") of the + * processors that hold the maximal value. + */ unsigned int max_index; /**