From: guido Date: Sun, 11 Jan 2004 12:31:57 +0000 (+0000) Subject: changes for Doxygen X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=27a68d8a21f7002daf63cf4600645e8194ca96ec;p=dealii-svn.git changes for Doxygen git-svn-id: https://svn.dealii.org/trunk@8305 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/deal.II/include/numerics/vectors.h b/deal.II/deal.II/include/numerics/vectors.h index b2bb7379c1..8eca6dce51 100644 --- a/deal.II/deal.II/include/numerics/vectors.h +++ b/deal.II/deal.II/include/numerics/vectors.h @@ -2,7 +2,7 @@ // $Id$ // Version: $Name$ // -// Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003 by the deal.II authors +// Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004 by the deal.II authors // // This file is subject to QPL and may not be distributed // without copyright and license information. Please refer @@ -34,36 +34,36 @@ template class DoFHandler; class ConstraintMatrix; - +//TODO: Move documentation of functions to the functions! +//TODO: (Re)move the basic course on Sobolev spaces /** - * Provide a class which offers some operations on vectors. Amoung these are - * assemblage of standard vectors, integration of the difference of a - * finite element solution and a continuous function, - * interpolations and projections of continuous functions to the finite - * element space and other operations. + * Provide a class which offers some operations on vectors. Amoung + * these are assembling of standard vectors, integration of the + * difference of a finite element solution and a continuous function, + * interpolations and projections of continuous functions to the + * finite element space and other operations. * - * There exist two versions of almost each function. One with a - * @ref{Mapping} argument and one without. If a code uses a mapping - * different from @ref{MappingQ1} the functions @em{with} mapping - * argument should be used. Code that uses only @ref{MappingQ1} may - * also use the functions @em{without} @ref{Mapping} argument. Each of - * these latter functions create a @ref{MappingQ1} object and just - * call the respective functions with that object as mapping - * argument. The functions without @ref{Mapping} argument still exist - * to ensure backward compatibility. Nevertheless it is advised to - * change the user's codes to store a specific @ref{Mapping} object - * and to use the functions that take this @p{Mapping} object as - * argument. This gives the possibility to easily extend the user - * codes to work also on mappings of higher degree, this just by - * exchanging @ref{MappingQ1} by, for example, a @ref{MappingQ} or - * another @ref{Mapping} object of interest. + * @note There exist two versions of almost each function. One with a + * Mapping argument and one without. If a code uses a mapping + * different from MappingQ1 the functions with mapping argument + * should be used. Code that uses only MappingQ1 may also use the + * functions without Mapping argument. Each of these latter functions + * create a MappingQ1 object and just call the respective functions + * with that object as mapping argument. The functions without Mapping + * argument still exist to ensure backward compatibility. Nevertheless + * it is advised to change the user's codes to store a specific + * Mapping object and to use the functions that take this Mapping + * object as argument. This gives the possibility to easily extend the + * user codes to work also on mappings of higher degree, this just by + * exchanging MappingQ1 by, for example, a MappingQ or another Mapping + * object of interest. * - * @sect3{Description of operations} + * @section VectorTools1 Description of operations * * This collection of methods offers the following operations: - * @begin{itemize} - * @item Interpolation: assign each degree of freedom in the vector to be + *