From: wolf Date: Wed, 2 Jun 1999 13:35:08 +0000 (+0000) Subject: Change the layout of the documentation to move the doc of a local enum X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=02f7dc5d805dfe2dd737167daebac05ea7289b19;p=dealii-svn.git Change the layout of the documentation to move the doc of a local enum to the general doc. It seems that this was the reasons that confused kdoc. git-svn-id: https://svn.dealii.org/trunk@1367 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/lac/include/lac/solver_control.h b/deal.II/lac/include/lac/solver_control.h index aae67793cf..02b370231a 100644 --- a/deal.II/lac/include/lac/solver_control.h +++ b/deal.II/lac/include/lac/solver_control.h @@ -23,32 +23,34 @@ * * #check()# can be replaced in derived classes to allow for more * sophisticated tests. + * + * + * \section{State} + * The return states of the check function are of type #State#, which is an + * enum local to this class. It indicates the state the + * 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. + *
*/ class SolverControl : public Subscriptor { public: - /** - * Return states of the check - * function, which indicate the state the - * 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. - *
- */ + enum State { - iterate = 0, success, failure + iterate = 0, success, failure }; /** @@ -159,6 +161,8 @@ class SolverControl : public Subscriptor + + /** * Specialization of #SolverControl# which returns #success# if either * the specified tolerance is achieved or if the