]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Avoid a number of doxygen markup warnings.
authorWolfgang Bangerth <bangerth@math.tamu.edu>
Fri, 27 Apr 2012 09:19:06 +0000 (09:19 +0000)
committerWolfgang Bangerth <bangerth@math.tamu.edu>
Fri, 27 Apr 2012 09:19:06 +0000 (09:19 +0000)
git-svn-id: https://svn.dealii.org/trunk@25460 0785d39b-7218-0410-832d-ea1e28bc413d

15 files changed:
deal.II/include/deal.II/algorithms/newton.h
deal.II/include/deal.II/algorithms/operator.h
deal.II/include/deal.II/algorithms/timestep_control.h
deal.II/include/deal.II/base/flow_function.h
deal.II/include/deal.II/base/logstream.h
deal.II/include/deal.II/base/subscriptor.h
deal.II/include/deal.II/fe/fe_dg_vector.h
deal.II/include/deal.II/fe/mapping.h
deal.II/include/deal.II/lac/parallel_vector.h
deal.II/include/deal.II/lac/precondition_block_base.h
deal.II/include/deal.II/meshworker/dof_info.h
deal.II/include/deal.II/meshworker/functional.h
deal.II/include/deal.II/meshworker/output.h
deal.II/include/deal.II/multigrid/mg_coarse.h
deal.II/include/deal.II/multigrid/mg_smoother.h

index 7bd649cad15a86548e9428e6856ba8c4049de2d0..f3cdcee24bc3507c9a53d4f51d930b247d89b1d1 100644 (file)
@@ -190,7 +190,7 @@ namespace Algorithms
       bool debug_vectors;
                                        /**
                                         * Write debug output to
-                                        * #deallog; the higher the
+                                        * @p deallog; the higher the
                                         * number, the more output.
                                         */
       unsigned int debug;
index 0a58d365f86a86dcecae1ca05db5ef48b6a89be0..ca9b9ca98aea09e7b41610656df85fdd55c95dde 100644 (file)
@@ -103,12 +103,13 @@ namespace Algorithms
                                         * Empty virtual destructor.
                                         */
       virtual ~OutputOperator();
+
       /**
-       * Set the stream #os to
+       * Set the stream @p os to
        * which data is written. If
        * no stream is selected with
        * this function, data goes
-       * to #deallog.
+       * to @p deallog.
        */
       void initialize_stream(std::ostream& stream);
                                        /**
index 12ddde717b04f4992cd5cd6c4e0a2d9fbc857fce..2c7f3ea94b8d13f44b5b695bd02c90396f654581 100644 (file)
@@ -42,7 +42,7 @@ namespace Algorithms
  * <li> The resulting step size is used from the current time.
  * </ol>
  *
- * The variable #print_step can be used to control the amount of
+ * The variable @p print_step can be used to control the amount of
  * output generated by the timestepping scheme.
  */
   class TimestepControl : public Subscriptor
@@ -201,7 +201,7 @@ namespace Algorithms
                                        /**
                                         * The size of the current time
                                         * step. This may differ from
-                                        * #step_val, if we aimed at #final_val.
+                                        * @p step_val, if we aimed at @p final_val.
                                         */
       double current_step_val;
       double step_val;
index cc1d5711f056a6b53369c710e505adeb15b5e793..cbbb544ad1194c51eb0fc321c70f08329b74bb79 100644 (file)
@@ -147,8 +147,8 @@ namespace Functions
 
 /**
  * Laminar pipe flow in two and three dimensions. The channel
- * stretches along the <i>x</i>-axis and has radius #radius. The
- * #Reynolds number is used to scale the pressure properly for a
+ * stretches along the <i>x</i>-axis and has radius @p radius. The
+ * @p Reynolds number is used to scale the pressure properly for a
  * Navier-Stokes problem.
  *
  * @ingroup functions
index 29714298e8dac21784d38a0738416213e4573c27..3ebbb2b83490f27a179dd880b153383d50128df9 100644 (file)
@@ -95,7 +95,7 @@ class LogStream : public Subscriptor
                                       * a block, create one of these
                                       * objects, and it will appear as
                                       * a prefix in LogStream output
-                                      * like #deallog. At the end of
+                                      * like @p deallog. At the end of
                                       * the block, the prefix will
                                       * automatically be removed, when
                                       * this object is destroyed.
@@ -105,7 +105,7 @@ class LogStream : public Subscriptor
       public:
                                          /**
                                           * Set a new prefix for
-                                          * #deallog, which will be
+                                          * @p deallog, which will be
                                           * removed when the variable
                                           * is destroyed .
                                           */
index 7fd27ab85f75fd76b5da7e10548b7bfebb111f32..3b3fecd6bb10ac344ae2bd92696523594e5a149c 100644 (file)
@@ -115,7 +115,7 @@ class Subscriptor
     unsigned int n_subscriptions () const;
 
                                      /**
-                                      * List the subscribers to #deallog.
+                                      * List the subscribers to @p deallog.
                                       */
     void list_subscribers () const;
 
index 240cac95416730a7e698df44a3a08c87e40c5282..132f551ecf0a9b08abf4b3974530e600af8b0e4c 100644 (file)
@@ -114,7 +114,7 @@ class FE_DGVector
                                       * generalized_support_points
                                       * field of the FiniteElement
                                       * class and fill the tables with
-                                      * #interior_weights. Called
+                                      * @p interior_weights. Called
                                       * from the constructor.
                                       */
     void initialize_support_points (const unsigned int degree);
index 1294e8e1908740bbda40f6e32c5624b8f6d2b507..f0e5c2931f70329c5acb287b08ebda5664c38f51 100644 (file)
@@ -143,7 +143,7 @@ enum MappingType
  * reference cell, nothing needs to be done for them. For a function
  * defined on the computational domain, the quadrature points need to
  * be mapped, which is done in fill_fe_values() if
- * #update_quadrature_points is set in the update flags. The mapped
+ * @p update_quadrature_points is set in the update flags. The mapped
  * quadrature points are then accessed through FEValuesBase::quadrature_point().
  *
  * @todo Add a function <tt>transform_quadrature_points</tt> for this.
@@ -159,7 +159,7 @@ enum MappingType
  *
  * The transformed quadrature weights $\left|\text{det}J(\mathbf{\hat
  * x})\right|$ are accessed through FEValuesBase::JxW() and
- * computed in fill_fe_values(), if #update_JxW_values is set in the
+ * computed in fill_fe_values(), if @p update_JxW_values is set in the
  * update flags.
  *
  * @todo Add a function <tt>transform_quadrature_weights</tt> for
@@ -430,12 +430,12 @@ class Mapping : public Subscriptor
  *
  * @note Normally, this function is called by a finite element,
  * filling FEValues objects. For this finite element, there should be
- * an alias MappingType like #mapping_bdm, #mapping_nedelec, etc. This
+ * an alias MappingType like @p mapping_bdm, @p mapping_nedelec, etc. This
  * alias should be preferred to using the types below.
  *
  * The mapping types currently implemented by derived classes are:
  * <ul>
- * <li> #mapping_contravariant: maps a vector field on the reference cell
+ * <li> @p mapping_contravariant: maps a vector field on the reference cell
  * is to the physical cell through the Jacobian:
  * @f[
  * \mathbf u(\mathbf x) = J(\mathbf{\hat x})\mathbf{\hat u}(\mathbf{\hat x}).
@@ -444,7 +444,7 @@ class Mapping : public Subscriptor
  * transformation. Mathematically, it is the push forward of a
  * vector field.
  *
- * <li> #mapping_covariant: maps a field of one-forms on the reference cell
+ * <li> @p mapping_covariant: maps a field of one-forms on the reference cell
  * to a field of one-forms on the physical cell.
  * (theoretically this would refer to a DerivativeForm<1, dim, 1> but it
  * canonically identified with a Tensor<1,dim>).
@@ -460,7 +460,7 @@ class Mapping : public Subscriptor
  * @f]
  * Gradients of scalar differentiable functions are transformed this way.
  *
- * <li> #mapping_piola: A field of <i>n-1</i>-forms on the reference cell is also
+ * <li> @p mapping_piola: A field of <i>n-1</i>-forms on the reference cell is also
  * represented by a vector field, but again transforms differently,
  * namely by the Piola transform
  * @f[
@@ -488,7 +488,7 @@ class Mapping : public Subscriptor
 
    The mapping types currently implemented by derived classes are:
    <ul>
-   <li> #mapping_covariant: maps a field of forms on the reference cell
+   <li> @p mapping_covariant: maps a field of forms on the reference cell
    to a field of forms on the physical cell.
    Mathematically, it is the pull back of the differential form
    @f[
@@ -527,7 +527,7 @@ class Mapping : public Subscriptor
    The mapping types currently implemented by derived classes are:
    <ul>
 
-   <li> #mapping_contravariant_gradient, it
+   <li> @p mapping_contravariant_gradient, it
    assumes $\mathbf u(\mathbf x) = J \mathbf{\hat u}$ so that
    @f[
    \mathbf T(\mathbf x) =
@@ -535,7 +535,7 @@ class Mapping : public Subscriptor
    J^{-1}(\mathbf{\hat x}).
    @f]
 
-   <li> #mapping_covariant_gradient, it
+   <li> @p mapping_covariant_gradient, it
    assumes $\mathbf u(\mathbf x) = J^{-T} \mathbf{\hat u}$ so that
    @f[
    \mathbf T(\mathbf x) =
@@ -543,7 +543,7 @@ class Mapping : public Subscriptor
    J^{-1}(\mathbf{\hat x}).
    @f]
 
-   <li> #mapping_piola_gradient, it
+   <li> @p mapping_piola_gradient, it
    assumes $\mathbf u(\mathbf x) = \frac{1}{\text{det}J(\mathbf x)}
    J(\mathbf x) \mathbf{\hat u}(\mathbf x)$
    so that
@@ -555,8 +555,8 @@ class Mapping : public Subscriptor
    @f]
    </ul>
 
-   @todo The formulas for #mapping_covariant_gradient,
-   #mapping_contravariant_gradient and #mapping_piola_gradient
+   @todo The formulas for @p mapping_covariant_gradient,
+   @p mapping_contravariant_gradient and @p mapping_piola_gradient
    are only true as stated for linear mappings,
    if the mapping is bilinear for example then there is a missing
    term associated with the derivative of of J.
index d2d96f4a6324ac21e2b63f0c76008a0a656420c7..8edc9b91d128a2ea7633898b11b94c4c26dc0594 100644 (file)
@@ -41,7 +41,7 @@ namespace parallel
 
                                      /**
                                       * Implementation of a parallel vector class. The design of this class is
-                                      * similar to the standard dealii::Vector<Number> class in deal.II, with the
+                                      * similar to the standard ::dealii::Vector class in deal.II, with the
                                       * exception that storage is distributed with MPI.
                                       *
                                       * The vector is designed for the following scheme of parallel partitioning:
@@ -919,7 +919,7 @@ namespace parallel
 
                                          /**
                                           * Provide this class with all functionality
-                                          * of ::dealii::Vector<Number> by creating a
+                                          * of ::dealii::Vector by creating a
                                           * VectorView object.
                                           */
         VectorView<Number> vector_view;
index 097256c164e08ca6b82c70c55dc125ea0aa4c9e3..ea2cd190db9191f23d0cf2f02a7b7b3d6a41eff1 100644 (file)
@@ -230,7 +230,7 @@ class PreconditionBlockBase
 
                                     /**
                                      * Print some statistics about
-                                     * the inverses to #deallog. Output depends
+                                     * the inverses to @p deallog. Output depends
                                      * on #Inversion. It is richest
                                      * for svd, where we obtain
                                      * statistics on extremal
@@ -238,7 +238,7 @@ class PreconditionBlockBase
                                      * numbers.
                                      */
     void log_statistics () const;
-    
+
                                     /**
                                      * Determine an estimate for the
                                      * memory consumption (in bytes)
@@ -682,7 +682,7 @@ PreconditionBlockBase<number>::log_statistics () const
       unsigned int kermin = 100000000, kermax = 0;
       double sigmin = 1.e300, sigmax= -1.e300;
       double kappamin = 1.e300, kappamax= -1.e300;
-      
+
       for (unsigned int b=0;b<size();++b)
        {
          const LAPACKFullMatrix<number>& matrix = inverse_svd(b);
@@ -692,18 +692,18 @@ PreconditionBlockBase<number>::log_statistics () const
          const double s0 = matrix.singular_value(0);
          const double sm = matrix.singular_value(matrix.n_cols()-k);
          const double co = sm/s0;
-         
+
          if (kermin > k) kermin = k-1;
          if (kermax < k) kermax = k-1;
          if (s0 < sigmin) sigmin = s0;
          if (sm > sigmax) sigmax = sm;
          if (co < kappamin) kappamin = co;
-         if (co > kappamax) kappamax = co;         
+         if (co > kappamax) kappamax = co;
        }
       deallog << "dim ker [" << kermin << ':' << kermax
              << "] sigma [" << sigmin << ':' << sigmax
              << "] kappa [" << kappamin << ':' << kappamax << ']' << std::endl;
-      
+
     }
   else if (inversion == householder)
     {
index c8e2f13478e2b6fbb156d491e42b6196ec0a7a31..6abc49fa0e664f2423fa8b4e2b2a040ada3570a4 100644 (file)
@@ -50,7 +50,7 @@ namespace MeshWorker
  * the vector has been changed from zero-length, then local dof
  * indices stored in this object will automatically be renumbered to
  * reflect local block structure. This means, the first entries in
- * #indices will refer to the first block of the system, then comes
+ * @p indices will refer to the first block of the system, then comes
  * the second block and so on.
  *
  * The BlockInfo object is stored as a pointer. Therefore, if the
@@ -123,14 +123,14 @@ namespace MeshWorker
 
                                        /**
                                         * Set the current cell and
-                                        * fill #indices.
+                                        * fill @p indices.
                                         */
       template <class DHCellIterator>
       void reinit(const DHCellIterator& c);
 
                                        /**
                                         * Set the current face and
-                                        * fill #indices if the #cell
+                                        * fill @p indices if the #cell
                                         * changed.
                                         */
       template <class DHCellIterator, class DHFaceIterator>
@@ -140,7 +140,7 @@ namespace MeshWorker
 
                                        /**
                                         * Set the current subface
-                                        * and fill #indices if the
+                                        * and fill @p indices if the
                                         * #cell changed.
                                         */
       template <class DHCellIterator, class DHFaceIterator>
@@ -152,7 +152,7 @@ namespace MeshWorker
                                        /**
                                         * Switch to a new face of the
                                         * same cell. Does not change
-                                        * #indices and does not reset
+                                        * @p indices and does not reset
                                         * data in LocalResults.
                                         */
       template <class DHFaceIterator>
@@ -161,7 +161,7 @@ namespace MeshWorker
                                        /**
                                         * Switch to a new subface of the
                                         * same cell. Does not change
-                                        * #indices and does not reset
+                                        * @p indices and does not reset
                                         * data in LocalResults.
                                         */
       template <class DHFaceIterator>
index 06c23f0964389b2528260c4ea0b64dd84d469109..b0c3ff591d7b29fbe801d57aa3660a932d9b334a 100644 (file)
@@ -111,15 +111,15 @@ namespace MeshWorker
                                          /**
                                           * The initialization
                                           * function, specifying the
-                                          * #results vectors and
+                                          * @p results vectors and
                                           * whether face data should
                                           * be collected separately.
                                           *
-                                          * #results should contain
+                                          * @p results should contain
                                           * two block vectors named
                                           * "cells" and "faces" (the
                                           * latter only if
-                                          * #separate_faces is
+                                          * @p separate_faces is
                                           * true). In each of the two,
                                           * each block should have
                                           * equal size and be large
@@ -179,7 +179,7 @@ namespace MeshWorker
 
                                          /**
                                           * The value of the ith entry
-                                          * in #results.
+                                          * in @p results.
                                           */
         number operator() (unsigned int i) const;
       private:
index 1d82917aa427a2a0135d4c3a8e7b52fce51a4f8e..87ccb278699cfbf3a782035d24216812d5d3db3c 100644 (file)
@@ -69,7 +69,7 @@ namespace MeshWorker
                                           * which data is written. If
                                           * no stream is selected with
                                           * this function, data goes
-                                          * to #deallog.
+                                          * to @p deallog.
                                           */
         void initialize_stream (std::ostream& stream);
 
@@ -109,7 +109,7 @@ namespace MeshWorker
                                           * Write the object T either
                                           * to the stream #os, if initialize_stream
                                           * has been called, or to
-                                          * #deallog if no pointer has
+                                          * @p deallog if no pointer has
                                           * been set.
                                           */
         template<typename T>
@@ -119,7 +119,7 @@ namespace MeshWorker
                                           * Write an end-of-line marker either
                                           * to the stream #os, if initialize_stream
                                           * has been called, or to
-                                          * #deallog if no pointer has
+                                          * @p deallog if no pointer has
                                           * been set.
                                           */
         void write_endl () const;
index a8792cf6cd1a6a4906ae6d95b2b5ecee7172a398..a50182ae3ca5e623fd335dc17dbca52986b36d53 100644 (file)
@@ -134,7 +134,7 @@ class MGCoarseGridHouseholder : public MGCoarseGridBase<VECTOR>
                                       * Initialize for a new matrix.
                                       */
     void initialize (const FullMatrix<number>& A);
-    
+
     void operator() (const unsigned int   level,
                      VECTOR       &dst,
                      const VECTOR &src) const;
@@ -150,7 +150,7 @@ class MGCoarseGridHouseholder : public MGCoarseGridBase<VECTOR>
  * Coarse grid solver using singular value decomposition of LAPACK matrices.
  *
  * Upon initialization, the singular value decomposition of the matrix is
- * computed. then, the operator() uses 
+ * computed. then, the operator() uses
  *
  * @author Guido Kanschat, 2003, 2012
  */
@@ -163,25 +163,25 @@ class MGCoarseGridSVD : public MGCoarseGridBase<VECTOR>
                                       * uninitialized object.
                                       */
     MGCoarseGridSVD ();
-    
+
                                      /**
                                       * Initialize for a new
                                       * matrix. This resets the
-                                      * dimensions to the 
+                                      * dimensions to the
                                       */
     void initialize (const FullMatrix<number>& A, const double threshold = 0);
-    
+
     void operator() (const unsigned int   level,
                      VECTOR       &dst,
                      const VECTOR &src) const;
-    
+
                                     /**
-                                     * Write the singular values to #deallog.
+                                     * Write the singular values to @p deallog.
                                      */
     void log () const;
-    
+
   private:
-    
+
                                      /**
                                       * Matrix for singular value decomposition.
                                       */
@@ -352,7 +352,7 @@ void
 MGCoarseGridSVD<number, VECTOR>::log() const
 {
   const unsigned int n = std::min(matrix.n_rows(), matrix.n_cols());
-  
+
   for (unsigned int i=0;i<n;++i)
     deallog << ' ' << matrix.singular_value(i);
   deallog << std::endl;
index c4457f24519972ed9f95d83b096260fd70ce8189..cef5e53639799c65e00d95dd91f89b6abedc5ea2 100644 (file)
@@ -99,9 +99,9 @@ class MGSmoother : public MGSmootherBase<VECTOR>
     void set_transpose (const bool);
 
                                      /**
-                                      * Set #debug to a nonzero value
+                                      * Set @p debug to a nonzero value
                                       * to get debug information
-                                      * logged to #deallog. Increase
+                                      * logged to @p deallog. Increase
                                       * to get more information
                                       */
     void set_debug (const unsigned int level);
@@ -151,7 +151,7 @@ class MGSmoother : public MGSmootherBase<VECTOR>
 
                                      /**
                                       * Output debugging information
-                                      * to #deallog if this is
+                                      * to @p deallog if this is
                                       * nonzero.
                                       */
     unsigned int debug;

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.