From 4760a0e76630c804acaf526f86b68db7ef80a2ea Mon Sep 17 00:00:00 2001 From: heister Date: Wed, 22 Sep 2010 16:05:32 +0000 Subject: [PATCH] fix documentation. git-svn-id: https://svn.dealii.org/trunk@22120 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/lac/include/lac/sparsity_tools.h | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/deal.II/lac/include/lac/sparsity_tools.h b/deal.II/lac/include/lac/sparsity_tools.h index 442ac45bf7..dabf7e35e6 100644 --- a/deal.II/lac/include/lac/sparsity_tools.h +++ b/deal.II/lac/include/lac/sparsity_tools.h @@ -199,20 +199,21 @@ namespace SparsityTools #ifdef DEAL_II_COMPILER_SUPPORTS_MPI /** * Communciate rows in a compressed - * sparsity pattern over MPI. The @param - * csp is modified inline. All entries in - * rows that belong to a different + * sparsity pattern over MPI. The parameter + * @p csp is modified inline. All entries + * in rows that belong to a different * processor are send to them and added * there. The ownership is determined by - * parameter @param rows_per_cpu. The - * IndexSet @param myrange should be the - * one used in the constructor of the - * CompressedSimpleSparsityPattern. All - * rows contained in @param myrange are - * checked in @param csp. This function - * needs to be used with + * the parameter @p rows_per_cpu. The + * IndexSet @p myrange should be the one + * used in the constructor of the + * CompressedSimpleSparsityPattern. Only + * the rows in @p csp contained in @p + * myrange are checked for transfer. This + * function needs to be used with * PETScWrappers::MPI::SparseMatrix for it - * to work correctly. + * to work correctly in a parallel + * calculation. */ template void distribute_sparsity_pattern(CSP_t & csp, -- 2.39.5