From: bangerth Date: Tue, 15 Jan 2013 02:50:11 +0000 (+0000) Subject: Doc updates. X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=6cdb64c00332fd7598f200f9c4cd4e5a57cf0603;p=dealii-svn.git Doc updates. git-svn-id: https://svn.dealii.org/trunk@28056 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/include/deal.II/lac/block_matrix_array.h b/deal.II/include/deal.II/lac/block_matrix_array.h index 73ae0d19a0..73420c5353 100644 --- a/deal.II/include/deal.II/lac/block_matrix_array.h +++ b/deal.II/include/deal.II/lac/block_matrix_array.h @@ -1,7 +1,7 @@ //--------------------------------------------------------------------------- // $Id$ // -// Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2012 by the deal.II authors +// Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2012, 2013 by the deal.II authors // // This file is subject to QPL and may not be distributed // without copyright and license information. Please refer @@ -152,8 +152,8 @@ public: * Constructor fixing the * dimensions. * - * @deprecated the last argument - * is ignored. + * @deprecated The last argument is ignored. Use the constructor with only + * the first two arguments. */ BlockMatrixArray (const unsigned int n_block_rows, const unsigned int n_block_cols, @@ -166,8 +166,8 @@ public: * created by the default * constructor. * - * @deprecated the last argument - * is ignored. + * @deprecated The last argument is ignored. Use the function with same name + * but only the first two arguments. */ void initialize (const unsigned int n_block_rows, const unsigned int n_block_cols, @@ -212,8 +212,9 @@ public: * matrices not having functions * vmult_add() and TVmult_add(). * - * @deprecated the first argument - * is ignored. + * @deprecated The first argument + * is ignored. Use the function with same name + * but without the first argument. */ template void enter_aux (VectorMemory > &mem, @@ -484,7 +485,7 @@ public: * n_blocks is the * number of blocks in each direction. */ - BlockTrianglePrecondition (unsigned int n_blocks); + BlockTrianglePrecondition (const unsigned int n_blocks); /** * Constructor. This matrix must be @@ -492,12 +493,12 @@ public: * parameter allows for backward * insertion instead of forward. * - * @deprecated the second argument - * is ignored. + * @deprecated The second argument is ignored. Use the constructor with only + * the first and third argument. */ - BlockTrianglePrecondition (unsigned int n_block_rows, + BlockTrianglePrecondition (const unsigned int n_block_rows, VectorMemory > &mem, - bool backward = false) DEAL_II_DEPRECATED; + const bool backward = false) DEAL_II_DEPRECATED; /** * Initialize object @@ -506,18 +507,18 @@ public: * created by the default * constructor. * - * @deprecated the second argument - * is ignored. + * @deprecated The second argument + * is ignored. Use the function without that argument. */ void initialize (const unsigned int n_block_rows, VectorMemory > &mem, - bool backward = false) DEAL_II_DEPRECATED; + const bool backward = false) DEAL_II_DEPRECATED; /** * Resize preconditioner to a new * size and clear all blocks. */ - void reinit(const unsigned int n_block_rows); + void reinit (const unsigned int n_block_rows); /** @@ -542,7 +543,7 @@ public: * matrices or preconditioners. * * @deprecated The first - * argument is ignored. User + * argument is ignored. Use * enter() instead. */ template