]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Remove several doxygen warnings.
authorRalf Hartmann <Ralf.Hartmann@dlr.de>
Fri, 23 Sep 2005 14:10:07 +0000 (14:10 +0000)
committerRalf Hartmann <Ralf.Hartmann@dlr.de>
Fri, 23 Sep 2005 14:10:07 +0000 (14:10 +0000)
git-svn-id: https://svn.dealii.org/trunk@11523 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/lac/include/lac/full_matrix.h
deal.II/lac/include/lac/petsc_block_sparse_matrix.h
deal.II/lac/include/lac/petsc_block_vector.h
deal.II/lac/include/lac/petsc_parallel_block_sparse_matrix.h
deal.II/lac/include/lac/petsc_parallel_block_vector.h
deal.II/lac/include/lac/petsc_parallel_vector.h
deal.II/lac/include/lac/petsc_vector.h
deal.II/lac/include/lac/petsc_vector_base.h

index ad8e2e959197aaeca53bfdd0000164a9252fddfd..e525dadc30f0699ee1a5017807d54d0df279254f 100644 (file)
@@ -420,9 +420,8 @@ class FullMatrix : public Table<2,number>
     number l1_norm () const;
 
                                     /**
-                                     * Return the
-                                     * <i>l<sub>&infin;</sub></i>-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).
index 5f0bb2f2d390b6026eab435cfd80ab16a41ec129..2b511b8e205b1cc0848fa0e1137a5e0fd29b04d3 100644 (file)
 #ifdef DEAL_II_USE_PETSC
 
 
-/*! @addtogroup PETSc
- *@{
- */
 
 namespace PETScWrappers
 {
   
+/*! @addtogroup PETScWrappers
+ *@{
+ */
 
 /**
  * Blocked sparse matrix based on the PETScWrappers::SparseMatrix class. This
index 104bc962110f7e90636c3850e4987330c299d313..d0f48088eca2213142be2fda8c3d1372081de96d 100644 (file)
 #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);
   }
-
-
-/*@}*/
   
 }
 
index bb0226c544c2f29f2d9512ecff249ac9fc411f02..e4fdd86e7763a3101bc209fa6425d215841f80dc 100644 (file)
 #ifdef DEAL_II_USE_PETSC
 
 
-/*! @addtogroup PETSc
- *@{
- */
 
 namespace PETScWrappers
 {
   namespace MPI
   {
-    
+
+/*! @addtogroup PETScWrappers
+ *@{
+ */   
 
 /**
  * Blocked sparse matrix based on the PETScWrappers::SparseMatrix class. This
index 44e86752516651ce3431c4a8e039ae8e08fca4dd..49bae14f7a81650c6d29e5d64466f8a44e4bbf3a 100644 (file)
 #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);
     }
-
-
-/*@}*/
-  
+    
   }
   
 }
index 2288f0de9b50e47cf331ddc32eeaabe429399384..421f04c86c6461c569a01d10feadcc6fb265e835 100644 (file)
@@ -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 <typename number>
     Vector::Vector (const MPI_Comm         &communicator,
index 75b7b47ea50af8c131da046ec5dc735da8dddbbf..653b0e83f7bb8c2e78330c7ad5adfccf8ecf9c81 100644 (file)
 
 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 <typename number>
   Vector::Vector (const ::Vector<number> &v)
index 219605c41fb6e71790cd423107f9d50429272ba5..9a7787cce7aae946e7182fa63b725fb42bf3810e 100644 (file)
@@ -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

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.