From: Guido Kanschat Date: Wed, 1 Feb 2006 20:50:22 +0000 (+0000) Subject: improve documentation a bit X-Git-Tag: v8.0.0~12463 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=2376c729fd90d258f76e417adae1c3b779b03b4a;p=dealii.git improve documentation a bit git-svn-id: https://svn.dealii.org/trunk@12216 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/lac/include/lac/sparse_ilu.h b/deal.II/lac/include/lac/sparse_ilu.h index fb82c6e407..b9ce69c170 100644 --- a/deal.II/lac/include/lac/sparse_ilu.h +++ b/deal.II/lac/include/lac/sparse_ilu.h @@ -67,22 +67,21 @@ class SparseILU : public SparseLUDecomposition * * 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 * 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 void vmult (Vector &dst, @@ -164,8 +163,8 @@ class SparseILU : public SparseLUDecomposition * 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 void Tvmult (Vector &dst,