]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
Doc update to finally make kdoc happy.
authorwolf <wolf@0785d39b-7218-0410-832d-ea1e28bc413d>
Fri, 4 Jun 1999 09:16:09 +0000 (09:16 +0000)
committerwolf <wolf@0785d39b-7218-0410-832d-ea1e28bc413d>
Fri, 4 Jun 1999 09:16:09 +0000 (09:16 +0000)
git-svn-id: https://svn.dealii.org/trunk@1368 0785d39b-7218-0410-832d-ea1e28bc413d

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

index 02b370231aaa7df7882cb04be4fe8bfdbbf03e96..ddc8e5cdbc6fed836c261366522da1c9009858ac 100644 (file)
  * 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>
+ * \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
     };
     

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.