From: Timo Heister <timo.heister@gmail.com>
Date: Thu, 3 Feb 2022 16:01:38 +0000 (-0500)
Subject: documentation fixes
X-Git-Tag: v9.4.0-rc1~528^2~1
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=7244f683b4e70f13585e9e6845ec0d025c7e45cf;p=dealii.git

documentation fixes
---

diff --git a/include/deal.II/lac/precondition.h b/include/deal.II/lac/precondition.h
index 142993d20d..2b6ee9a791 100644
--- a/include/deal.II/lac/precondition.h
+++ b/include/deal.II/lac/precondition.h
@@ -62,10 +62,12 @@ namespace LinearAlgebra
 
 
 /**
- * No preconditioning.  This class helps you, if you want to use a linear
- * solver without preconditioning. All solvers in LAC require a
- * preconditioner. Therefore, you must use the identity provided here to avoid
- * preconditioning. It can be used in the following way:
+ * This preconditioner implements the indentity operator.
+ * This class can be used you if you want to use a linear
+ * solver without preconditioning, because all linear solvers
+ * require usage of a preconditioner.
+ *
+ * It can be used in the following way:
  *
  * @code
  * SolverControl           solver_control (1000, 1e-12);
diff --git a/include/deal.II/lac/solver_bicgstab.h b/include/deal.II/lac/solver_bicgstab.h
index 7122f0a850..9f5836e0cb 100644
--- a/include/deal.II/lac/solver_bicgstab.h
+++ b/include/deal.II/lac/solver_bicgstab.h
@@ -85,7 +85,7 @@ namespace internal
  * Bicgstab algorithm by van der Vorst.
  *
  * For the requirements on matrices and vectors in order to work with this
- * class, see the documentation of the Solver base class.
+ * class, see the documentation of the SolverBase base class.
  *
  * Like all other solver classes, this class has a local structure called @p
  * AdditionalData which is used to pass additional parameters to the solver,
@@ -95,10 +95,11 @@ namespace internal
  * classes much easier and guarantees that these will continue to work even if
  * number or type of the additional parameters for a certain solver changes.
  *
- * The Bicgstab-method has two additional parameters: the first is a boolean,
+ * The Bicgstab method has two additional parameters found in the
+ * SolverBicgstab::AdditionalData struct: the first, @p exact_residual is a boolean,
  * deciding whether to compute the actual residual in each step (@p true) or
  * to use the length of the computed orthogonal residual (@p false). Note that
- * computing the residual causes a third matrix-vector-multiplication, though
+ * computing the residual causes a third matrix-vector multiplication, though
  * no additional preconditioning, in each step. The reason for doing this is,
  * that the size of the orthogonalized residual computed during the iteration
  * may be larger by orders of magnitude than the true residual. This is due to
@@ -108,7 +109,7 @@ namespace internal
  * works reasonably as well, the flag should be set to @p false in order to
  * increase the performance of the solver.
  *
- * The second parameter is the size of a breakdown criterion. It is difficult
+ * The second parameter @p breakdown is the size of a breakdown criterion. It is difficult
  * to find a general good criterion, so if things do not work for you, try to
  * change this value.
  *
diff --git a/include/deal.II/lac/solver_control.h b/include/deal.II/lac/solver_control.h
index 3f94de2e3d..3780328af7 100644
--- a/include/deal.II/lac/solver_control.h
+++ b/include/deal.II/lac/solver_control.h
@@ -322,7 +322,7 @@ public:
 
   /**
    * This exception is thrown if a function operating on the vector of history
-   * data of a SolverControl object id called, but storage of history data was
+   * data of a SolverControl object is called, but storage of history data was
    * not enabled by enable_history_data().
    */
   DeclException0(ExcHistoryDataRequired);