From: Wolfgang Bangerth <bangerth@math.tamu.edu>
Date: Wed, 27 Feb 2008 01:33:33 +0000 (+0000)
Subject: Add a few comment annotations.
X-Git-Tag: v8.0.0~9362
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=631c8c645b146787c43d33a49ddf401fdf986cdc;p=dealii.git

Add a few comment annotations.

git-svn-id: https://svn.dealii.org/trunk@15796 0785d39b-7218-0410-832d-ea1e28bc413d
---

diff --git a/deal.II/lac/include/lac/sparse_decomposition.h b/deal.II/lac/include/lac/sparse_decomposition.h
index 47564231b8..bfd1660792 100644
--- a/deal.II/lac/include/lac/sparse_decomposition.h
+++ b/deal.II/lac/include/lac/sparse_decomposition.h
@@ -295,7 +295,9 @@ class SparseLUDecomposition : protected SparseMatrix<number>,
 				      *
 				      * After this function is called
 				      * the preconditioner is ready to
-				      * be used (vmult).
+				      * be used (using the
+				      * <code>vmult</code> function of
+				      * derived classes).
 				      */
     template <typename somenumber>
     void initialize (const SparseMatrix<somenumber> &matrix,
@@ -304,8 +306,10 @@ class SparseLUDecomposition : protected SparseMatrix<number>,
 				     /**
 				      * This method is deprecated,
 				      * and left for backward
-				      * compability. It will be removed
+				      * compatibility. It will be removed
 				      * in later versions.
+				      *
+				      * @deprecated
 				      */
     void reinit (const SparsityPattern &sparsity);
 
@@ -314,6 +318,8 @@ class SparseLUDecomposition : protected SparseMatrix<number>,
 				      * and left for backward
 				      * compability. It will be removed
 				      * in later versions.
+				      *
+				      * @deprecated
 				      */
     template <typename somenumber>
     void decompose (const SparseMatrix<somenumber> &matrix,
@@ -324,6 +330,8 @@ class SparseLUDecomposition : protected SparseMatrix<number>,
 				      * and left for backward
 				      * compability. It will be removed
 				      * in later versions.
+				      *
+				      * @deprecated
                                       */ 
     virtual bool is_decomposed () const;