From: Timo Heister <timo.heister@gmail.com>
Date: Thu, 4 Dec 2014 20:37:16 +0000 (-0500)
Subject: clarify documentation of ConstraintMatrix::distribute(VECTOR)
X-Git-Tag: v8.2.0-rc1~31^2
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F285%2Fhead;p=dealii.git

clarify documentation of ConstraintMatrix::distribute(VECTOR)

This came up as a question on the mailing list so we should be more precise.
---

diff --git a/include/deal.II/lac/constraint_matrix.h b/include/deal.II/lac/constraint_matrix.h
index 1bfa3d1f77..305d5d72b1 100644
--- a/include/deal.II/lac/constraint_matrix.h
+++ b/include/deal.II/lac/constraint_matrix.h
@@ -1099,8 +1099,8 @@ public:
    * Trilinos vector wrapper class, or any other type having the same
    * interface.
    *
-   * Note that if called with a TrilinosWrappers::MPI::Vector it may not
-   * contain ghost elements.
+   * @note If called with a TrilinosWrappers::MPI::Vector or
+   * PETScWrappers::MPI::Vector @p vec must not contain ghost elements.
    */
   template <class VectorType>
   void distribute (VectorType &vec) const;