]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
Change the layout of the documentation to move the doc of a local enum
authorwolf <wolf@0785d39b-7218-0410-832d-ea1e28bc413d>
Wed, 2 Jun 1999 13:35:08 +0000 (13:35 +0000)
committerwolf <wolf@0785d39b-7218-0410-832d-ea1e28bc413d>
Wed, 2 Jun 1999 13:35:08 +0000 (13:35 +0000)
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

deal.II/lac/include/lac/solver_control.h

index aae67793cfb476747ac8287ae7a8f6056527666a..02b370231aaa7df7882cb04be4fe8bfdbbf03e96 100644 (file)
  *
  * #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
+ * <OL>
+ * <LI> #iterate = 0#: continue
+ * the iteration.
+ * <LI> #success#: the goal is reached,
+ * the iterative method can terminate
+ * successfully.
+ * <LI> #failure#!: the iterative
+ * method should stop because
+ * convergence cannot be achieved or at
+ * least was not achieved within the given
+ * maximal number of iterations.
+ * </OL>
  */
 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
-                                     * <OL>
-                                     * <LI> #iterate = 0#: continue
-                                     * the iteration.
-                                     * <LI> #success#: the goal is reached,
-                                     * the iterative method can terminate
-                                     * successfully.
-                                     * <LI> #failure#!: the iterative
-                                     * method should stop because
-                                     * convergence cannot be achieved or at
-                                     * least was not achieved within the given
-                                     * maximal number of iterations.
-                                     * </OL>
-                                     */
+
     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

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.