]> https://gitweb.dealii.org/ - dealii.git/commitdiff
improve documentation a bit
authorGuido Kanschat <dr.guido.kanschat@gmail.com>
Wed, 1 Feb 2006 20:50:22 +0000 (20:50 +0000)
committerGuido Kanschat <dr.guido.kanschat@gmail.com>
Wed, 1 Feb 2006 20:50:22 +0000 (20:50 +0000)
git-svn-id: https://svn.dealii.org/trunk@12216 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/lac/include/lac/sparse_ilu.h

index fb82c6e407f130aab0e204a77b44a2f693e52691..b9ce69c17082528b0f2f87ab567503f287014ce9 100644 (file)
@@ -67,22 +67,21 @@ class SparseILU : public SparseLUDecomposition<number>
                                      *
                                      * Call the @p initialize
                                      * function before using this
-                                     * object as preconditioner
-                                     * (@p vmult).
+                                     * object as preconditioner.
                                       */
     SparseILU ();
 
                                      /**
-                                     * This method is deprecated, and
-                                     * left for backward
-                                     * compability. It will be
-                                     * removed in later versions.
+                                     * @deprecated This method is
+                                     * deprecated, and left for
+                                     * backward compability. It will
+                                     * be removed in later versions.
                                       */
     SparseILU (const SparsityPattern &sparsity);
 
                                     /**
-                                     * Make the @p AdditionalData
-                                     * type in the base class
+                                     * Make
+                                     * SparseLUDecomposition::AdditionalData
                                      * accessible to this class as
                                      * well.
                                      */
@@ -150,8 +149,8 @@ class SparseILU : public SparseLUDecomposition<number>
                                      * i.e. do one forward-backward step
                                      * $dst=(LU)^{-1}src$.
                                      *
-                                     * The @p initialize function
-                                     * needs to be called beforehand.
+                                     * The initialize() function
+                                     * needs to be called before.
                                      */
     template <typename somenumber>
     void vmult (Vector<somenumber>       &dst,
@@ -164,8 +163,8 @@ class SparseILU : public SparseLUDecomposition<number>
                                      * i.e. do one forward-backward step
                                      * $dst=(LU)^{-T}src$.
                                      *
-                                     * The @p initialize function
-                                     * needs to be called beforehand.
+                                     * The initialize() function
+                                     * needs to be called before.
                                      */
     template <typename somenumber>
     void Tvmult (Vector<somenumber>       &dst,

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.