From: Ralf Hartmann Date: Fri, 23 Sep 2005 14:10:07 +0000 (+0000) Subject: Remove several doxygen warnings. X-Git-Tag: v8.0.0~13080 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=a04d39ac5555a59b020f4b40826a96e93e62d26d;p=dealii.git Remove several doxygen warnings. git-svn-id: https://svn.dealii.org/trunk@11523 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/lac/include/lac/full_matrix.h b/deal.II/lac/include/lac/full_matrix.h index ad8e2e9591..e525dadc30 100644 --- a/deal.II/lac/include/lac/full_matrix.h +++ b/deal.II/lac/include/lac/full_matrix.h @@ -420,9 +420,8 @@ class FullMatrix : public Table<2,number> number l1_norm () const; /** - * Return the - * l-norm - * of the matrix, where + * Return the $l_\infty$-norm of + * the matrix, where * $||M||_\infty = \max_i \sum_j * |M_{ij}|$ (maximum of the sums * over rows). diff --git a/deal.II/lac/include/lac/petsc_block_sparse_matrix.h b/deal.II/lac/include/lac/petsc_block_sparse_matrix.h index 5f0bb2f2d3..2b511b8e20 100644 --- a/deal.II/lac/include/lac/petsc_block_sparse_matrix.h +++ b/deal.II/lac/include/lac/petsc_block_sparse_matrix.h @@ -27,13 +27,13 @@ #ifdef DEAL_II_USE_PETSC -/*! @addtogroup PETSc - *@{ - */ namespace PETScWrappers { +/*! @addtogroup PETScWrappers + *@{ + */ /** * Blocked sparse matrix based on the PETScWrappers::SparseMatrix class. This diff --git a/deal.II/lac/include/lac/petsc_block_vector.h b/deal.II/lac/include/lac/petsc_block_vector.h index 104bc96211..d0f48088ec 100644 --- a/deal.II/lac/include/lac/petsc_block_vector.h +++ b/deal.II/lac/include/lac/petsc_block_vector.h @@ -24,12 +24,12 @@ #ifdef DEAL_II_USE_PETSC -/*! @addtogroup PETScWrappers - *@{ - */ namespace PETScWrappers { +/*! @addtogroup PETScWrappers + *@{ + */ /** * An implementation of block vectors based on the vector class implemented in @@ -461,16 +461,13 @@ namespace PETScWrappers -/*! @addtogroup PETScWrappers - *@{ - */ - /** * Global function which overloads the default implementation * of the C++ standard library which uses a temporary object. The * function simply exchanges the data of the two vectors. * - * @relates BlockVector + * @ingroup PETScWrappers + * @relates PETScWrappers::BlockVector * @author Wolfgang Bangerth, 2000 */ inline @@ -479,9 +476,6 @@ namespace PETScWrappers { u.swap (v); } - - -/*@}*/ } diff --git a/deal.II/lac/include/lac/petsc_parallel_block_sparse_matrix.h b/deal.II/lac/include/lac/petsc_parallel_block_sparse_matrix.h index bb0226c544..e4fdd86e77 100644 --- a/deal.II/lac/include/lac/petsc_parallel_block_sparse_matrix.h +++ b/deal.II/lac/include/lac/petsc_parallel_block_sparse_matrix.h @@ -25,15 +25,15 @@ #ifdef DEAL_II_USE_PETSC -/*! @addtogroup PETSc - *@{ - */ namespace PETScWrappers { namespace MPI { - + +/*! @addtogroup PETScWrappers + *@{ + */ /** * Blocked sparse matrix based on the PETScWrappers::SparseMatrix class. This diff --git a/deal.II/lac/include/lac/petsc_parallel_block_vector.h b/deal.II/lac/include/lac/petsc_parallel_block_vector.h index 44e8675251..49bae14f7a 100644 --- a/deal.II/lac/include/lac/petsc_parallel_block_vector.h +++ b/deal.II/lac/include/lac/petsc_parallel_block_vector.h @@ -23,10 +23,6 @@ #ifdef DEAL_II_USE_PETSC -/*! @addtogroup PETScWrappers - *@{ - */ - namespace PETScWrappers { // forward declaration @@ -34,6 +30,10 @@ namespace PETScWrappers namespace MPI { + +/*! @addtogroup PETScWrappers + *@{ + */ /** * An implementation of block vectors based on the parallel vector class @@ -448,19 +448,16 @@ namespace PETScWrappers this->components[i].swap (v.components[i]); ::swap (this->block_indices, v.block_indices); } - -/*! @addtogroup PETScWrappers - *@{ - */ /** * Global function which overloads the default implementation * of the C++ standard library which uses a temporary object. The * function simply exchanges the data of the two vectors. * - * @relates BlockVector + * @ingroup PETScWrappers + * @relates PETScWrappers::MPI::BlockVector * @author Wolfgang Bangerth, 2000 */ inline @@ -469,10 +466,7 @@ namespace PETScWrappers { u.swap (v); } - - -/*@}*/ - + } } diff --git a/deal.II/lac/include/lac/petsc_parallel_vector.h b/deal.II/lac/include/lac/petsc_parallel_vector.h index 2288f0de9b..421f04c86c 100644 --- a/deal.II/lac/include/lac/petsc_parallel_vector.h +++ b/deal.II/lac/include/lac/petsc_parallel_vector.h @@ -371,7 +371,6 @@ namespace PETScWrappers }; -#ifndef DOXYGEN // ------------------ template and inline functions ------------- @@ -380,6 +379,8 @@ namespace PETScWrappers * of the C++ standard library which uses a temporary object. The * function simply exchanges the data of the two vectors. * + * @ingroup PETScWrappers + * @relates PETScWrappers::MPI::Vector * @author Wolfgang Bangerth, 2004 */ inline @@ -389,6 +390,7 @@ namespace PETScWrappers } +#ifndef DOXYGEN template Vector::Vector (const MPI_Comm &communicator, diff --git a/deal.II/lac/include/lac/petsc_vector.h b/deal.II/lac/include/lac/petsc_vector.h index 75b7b47ea5..653b0e83f7 100644 --- a/deal.II/lac/include/lac/petsc_vector.h +++ b/deal.II/lac/include/lac/petsc_vector.h @@ -27,6 +27,10 @@ namespace PETScWrappers { +/*! @addtogroup PETScWrappers + *@{ + */ + /** * Implementation of a sequential vector class based on PETSC. All the * functionality is actually in the base class, except for the calls to @@ -36,7 +40,6 @@ namespace PETScWrappers * functions). Only the functions creating a vector of specific type differ, * and are implemented in this particular class. * - * @ingroup PETScWrappers * @author Wolfgang Bangerth, 2004 */ class Vector : public VectorBase @@ -190,8 +193,8 @@ namespace PETScWrappers void create_vector (const unsigned int n); }; +/*@}*/ -#ifndef DOXYGEN // ------------------ template and inline functions ------------- @@ -200,6 +203,8 @@ namespace PETScWrappers * of the C++ standard library which uses a temporary object. The * function simply exchanges the data of the two vectors. * + * @ingroup PETScWrappers + * @relates PETScWrappers::Vector * @author Wolfgang Bangerth, 2004 */ inline @@ -209,6 +214,7 @@ namespace PETScWrappers } +#ifndef DOXYGEN template Vector::Vector (const ::Vector &v) diff --git a/deal.II/lac/include/lac/petsc_vector_base.h b/deal.II/lac/include/lac/petsc_vector_base.h index 219605c41f..9a7787cce7 100644 --- a/deal.II/lac/include/lac/petsc_vector_base.h +++ b/deal.II/lac/include/lac/petsc_vector_base.h @@ -677,6 +677,7 @@ namespace PETScWrappers * function simply exchanges the data of the two vectors. * * @ingroup PETScWrappers + * @relates PETScWrappers::VectorBase * @author Wolfgang Bangerth, 2004 */ inline