From: ESeNonFossiIo <esenonfossiio@gmail.com>
Date: Wed, 17 Jun 2015 09:53:15 +0000 (+0200)
Subject: caveat has been removed
X-Git-Tag: v8.3.0-rc1~92^2
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=da80ea069b5601c2c03f51e2f2842c5a4c5cd539;p=dealii.git

caveat has been removed
---

diff --git a/include/deal.II/lac/block_linear_operator.h b/include/deal.II/lac/block_linear_operator.h
index 36acf4a369..1a93f03f73 100644
--- a/include/deal.II/lac/block_linear_operator.h
+++ b/include/deal.II/lac/block_linear_operator.h
@@ -325,14 +325,14 @@ block_diagonal_operator(const LinearOperator<typename Range::BlockType, typename
 /**
  * @relates LinearOperator
  *
- * This function implement a forward substitution argument to invert a lower
+ * This function implements a forward substitution argument to invert a lower
  * block triangular matrix.
- * It takes as argement an array of array of LinearOperators @p block_matrix
+ * As argument, it takes an array of array of LinearOperators @p block_matrix
  * representing a lower block triangular matrix and an array of LinearOperators
  * @p inverse_diagonal representing inverses of digonal blocks of @p block_matrix.
  *
- * Let us assume we have a linear system where each coefficient of the system is a
- * matrix:
+ * Let us assume we have a linear system with the following block structure:
+ *
  * A00 x0 + ...                   = y0
  * A01 x0 + A11 x1 + ...          = y1
  * ...        ...
@@ -344,10 +344,10 @@ block_diagonal_operator(const LinearOperator<typename Range::BlockType, typename
  * and therefore:
  *    xn = Ann^-1 ( yn - A0n x0 - ... - A(n-1)n x(n-1) )
  *
- * Notice that we are not using the whole matrix: just the lower triangular block
- * matrix obtained from @p block_matrix it is used.
+ * @note Notice that we are not using the whole matrix:
+ *       just the lower triangular block matrix obtained
+ *       from @p block_matrix it is used.
  *
- * Caveat: Tvmult and Tvmult_add have not been implemented, yet. This may lead to mistakes.
  * @ingroup LAOperators
  */
 template < unsigned int n,
@@ -434,14 +434,13 @@ block_forward_substitution(const std::array<std::array<LinearOperator<typename R
 /**
  * @relates LinearOperator
  *
- * This function implement a back substitution argument to invert an upper
+ * This function implements a back substitution argument to invert an upper
  * block triangular matrix.
- * It takes as argement an array of array of LinearOperators @p block_matrix
+ * As argument, it takes an array of array of LinearOperators @p block_matrix
  * representing an upper block triangular matrix and an array of LinearOperators
  * @p inverse_diagonal representing inverses of digonal blocks of @p block_matrix.
  *
- * Let us assume we have a linear system where each coefficient of the system is a
- * matrix:
+ * Let us assume we have a linear system with the following block structure:
  *
  * A00 x0 + A01 x1 + ... + A0n xn = yn
  *          A11 x1 + ...          = y1
@@ -454,10 +453,10 @@ block_forward_substitution(const std::array<std::array<LinearOperator<typename R
  * and therefore:
  *    x0 = A00^-1 ( y0 - A0n xn - ... - A01 x1 )
  *
- * Notice that we are not using the whole matrix: just the upper triangular block
- * matrix obtained from @p block_matrix it is used.
+ * @note Notice that we are not using the whole matrix:
+ *       just the upper triangular block matrix obtained
+ *       from @p block_matrix it is used.
  *
- * Caveat: Tvmult and Tvmult_add have not been implemented, yet. This may lead to mistakes.
  * @ingroup LAOperators
  */
 template < unsigned int n,