From: Peter Munch <peterrmuench@gmail.com>
Date: Wed, 2 Sep 2020 14:27:28 +0000 (+0200)
Subject: Small fixes in the documentatio of L:d:V
X-Git-Tag: v9.3.0-rc1~1144^2
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F10878%2Fhead;p=dealii.git

Small fixes in the documentatio of L:d:V
---

diff --git a/include/deal.II/lac/la_parallel_vector.h b/include/deal.II/lac/la_parallel_vector.h
index 377b755995..1186423416 100644
--- a/include/deal.II/lac/la_parallel_vector.h
+++ b/include/deal.II/lac/la_parallel_vector.h
@@ -1254,8 +1254,7 @@ namespace LinearAlgebra
 
       /**
        * Temporary storage that holds the data that is sent to this processor
-       * in @p compress() or sent from this processor in
-       * @p update_ghost_values.
+       * in compress() or sent from this processor in update_ghost_values().
        */
       mutable ::dealii::MemorySpace::MemorySpaceData<Number, MemorySpace>
         import_data;
@@ -1271,7 +1270,7 @@ namespace LinearAlgebra
 
 #ifdef DEAL_II_WITH_MPI
       /**
-       * A vector that collects all requests from @p compress() operations.
+       * A vector that collects all requests from compress() operations.
        * This class uses persistent MPI communicators, i.e., the communication
        * channels are stored during successive calls to a given function. This
        * reduces the overhead involved with setting up the MPI machinery, but
@@ -1281,22 +1280,22 @@ namespace LinearAlgebra
       std::vector<MPI_Request> compress_requests;
 
       /**
-       * A vector that collects all requests from @p update_ghost_values()
+       * A vector that collects all requests from update_ghost_values()
        * operations. This class uses persistent MPI communicators.
        */
       mutable std::vector<MPI_Request> update_ghost_values_requests;
 #endif
 
       /**
-       * A lock that makes sure that the @p compress and @p
-       * update_ghost_values functions give reasonable results also when used
+       * A lock that makes sure that the compress() and update_ghost_values()
+       * functions give reasonable results also when used
        * with several threads.
        */
       mutable std::mutex mutex;
 
       /**
        * A helper function that clears the compress_requests and
-       * update_ghost_values_requests field. Used in reinit functions.
+       * update_ghost_values_requests field. Used in reinit() functions.
        */
       void
       clear_mpi_requests();