From 5c78250aac4199daa61f1c8bb74244be679490c3 Mon Sep 17 00:00:00 2001 From: wolf Date: Fri, 4 Jun 1999 09:16:09 +0000 Subject: [PATCH] Doc update to finally make kdoc happy. git-svn-id: https://svn.dealii.org/trunk@1368 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/lac/include/lac/solver_control.h | 28 ++++++++++++------------ 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/deal.II/lac/include/lac/solver_control.h b/deal.II/lac/include/lac/solver_control.h index 02b370231a..ddc8e5cdbc 100644 --- a/deal.II/lac/include/lac/solver_control.h +++ b/deal.II/lac/include/lac/solver_control.h @@ -31,25 +31,25 @@ * solver is in. * * The possible values of State are - *
    - *
  1. #iterate = 0#: continue - * the iteration. - *
  2. #success#: the goal is reached, - * the iterative method can terminate - * successfully. - *
  3. #failure#!: the iterative - * method should stop because - * convergence cannot be achieved or at - * least was not achieved within the given - * maximal number of iterations. - *
+ * \begin{itemize} + * \item #iterate = 0#: continue the iteration. + * \item #success#: the goal is reached, the iterative method can terminate + * successfully. + * \item #failure#: the iterative method should stop because convergence + * could not be achieved or at least was not achieved within the given + * maximal number of iterations. + * \end{itemize} */ class SolverControl : public Subscriptor { public: - enum State - { + /** + * #Enum# denoting the different states + * a solver can be in. See the general + * documentation for more information. + */ + enum State { iterate = 0, success, failure }; -- 2.39.5