Merge pull request dealii#14157 from tjhei/epic-doxygen

Fix doxygen groups in many places

doc/doxygen/headers/iterators.h

@@ -383,7 +383,7 @@ levels, and accessors for objects of lower dimensionality do not have a
 @ingroup grid
 */
 
-//@}
+/** @} */
 
 
 /**

include/deal.II/algorithms/general_data_storage.h

@@ -177,8 +177,8 @@ class GeneralDataStorage : public Subscriptor
 
   /**
    * @name Data storage and access
+   * @{
    */
-  //@{
 
   /**
    * Store internally a copy of the given object. The copied object is
@@ -327,7 +327,7 @@ class GeneralDataStorage : public Subscriptor
   void
   remove_object_with_name(const std::string &name);
 
-  //@}
+  /** @} */
 
   /**
    * An entry with this name does not exist in the internal boost::any map.

include/deal.II/base/convergence_table.h

@@ -213,7 +213,7 @@ class ConvergenceTable : public TableHandler
   DeclException1(ExcRateColumnAlreadyExists,
                  std::string,
                  << "Rate column <" << arg1 << "> does already exist.");
-  //@}
+  /** @} */
 };
 
 

include/deal.II/base/data_out_base.h

@@ -401,7 +401,7 @@ namespace DataOutBase
       << "It is not possible to have a structural dimension of " << arg1
       << " to be larger than the space dimension of the surrounding"
       << " space " << arg2);
-    //@}
+    /** @} */
   };
 
 
@@ -553,7 +553,7 @@ namespace DataOutBase
       << "It is not possible to have a structural dimension of " << arg1
       << " to be larger than the space dimension of the surrounding"
       << " space " << arg2);
-    //@}
+    /** @} */
   };
 
 
@@ -2528,7 +2528,7 @@ namespace DataOutBase
                  << "There was an error opening Tecplot file " << arg1
                  << " for output.");
 
-  //@}
+  /** @} */
 } // namespace DataOutBase
 
 

include/deal.II/base/exceptions.h

@@ -626,8 +626,8 @@ namespace StandardExceptions
 {
   /**
    * @addtogroup Exceptions
+   * @{
    */
-  //@{
 
   /**
    * Exception denoting a division by zero.
@@ -1139,7 +1139,7 @@ namespace StandardExceptions
                  std::string,
                  << "There was an error in a cuSPARSE function: " << arg1);
 #endif
-  //@}
+  /** @} */
 
   /**
    * This function requires support for the Exodus II library.

include/deal.II/base/function_parser.h

@@ -368,7 +368,7 @@ class FunctionParser
                  << ") is not equal to the number of expressions (" << arg2
                  << ").");
 
-  //@}
+  /** @} */
 };
 
 

include/deal.II/base/mu_parser_internal.h

@@ -102,7 +102,7 @@ namespace internal
                    << "Parsing Error at Column " << arg1
                    << ". The parser said: " << arg2);
 
-    //@}
+    /** @} */
 
     /**
      * deal.II uses muParser as a purely internal dependency. To this end, we do

include/deal.II/base/parameter_handler.h

@@ -1716,7 +1716,7 @@ class ParameterHandler : public Subscriptor
        "file to include <"
     << arg3 << "> cannot be opened.");
 
-  //@}
+  /** @} */
 
 private:
   /**

include/deal.II/base/patterns.h

@@ -538,7 +538,7 @@ namespace Patterns
                    int,
                    << "The values " << arg1 << " and " << arg2
                    << " do not form a valid range.");
-    //@}
+    /** @} */
   private:
     /**
      * Copy of the pattern that each element of the list has to satisfy.
@@ -685,7 +685,7 @@ namespace Patterns
                    int,
                    << "The values " << arg1 << " and " << arg2
                    << " do not form a valid range.");
-    //@}
+    /** @} */
   private:
     /**
      * Copy of the patterns that each key and each value of the map has to
@@ -960,7 +960,7 @@ namespace Patterns
       int,
       << "A comma was found at position " << arg1
       << " of your input string, but commas are not allowed here.");
-    //@}
+    /** @} */
   private:
     /**
      * List of valid strings as passed to the constructor. We don't make this
@@ -1404,7 +1404,7 @@ namespace Patterns
                    std::string,
                    << "The string \"" << arg1
                    << "\" does not match the pattern \"" << arg2 << "\"");
-    //@}
+    /** @} */
   } // namespace Tools
 } // namespace Patterns
 

include/deal.II/base/qprojector.h

@@ -29,9 +29,10 @@
 DEAL_II_NAMESPACE_OPEN
 
 
-/*!@addtogroup Quadrature */
-/*@{*/
-
+/**
+ * @addtogroup Quadrature
+ * @{
+ */
 
 /**
  * This class is a helper class to facilitate the usage of quadrature formulae
@@ -333,7 +334,7 @@ class QProjector
   };
 };
 
-/*@}*/
+/** @} */
 
 
 // -------------------  inline and template functions ----------------

include/deal.II/base/quadrature.h

@@ -28,8 +28,10 @@
 
 DEAL_II_NAMESPACE_OPEN
 
-/*!@addtogroup Quadrature */
-/*@{*/
+/**
+ * @addtogroup Quadrature
+ * @{
+ */
 
 /**
  * Base class for quadrature formulae in arbitrary dimensions. This class
@@ -403,7 +405,7 @@ class QIterated : public Quadrature<dim>
 
 
 
-/*@}*/
+/** @} */
 
 #ifndef DOXYGEN
 

include/deal.II/base/quadrature_lib.h

@@ -23,8 +23,10 @@
 
 DEAL_II_NAMESPACE_OPEN
 
-/*!@addtogroup Quadrature */
-/*@{*/
+/**
+ * @addtogroup Quadrature
+ * @{
+ */
 
 /**
  * The Gauss-Legendre family of quadrature rules for numerical integration.
@@ -908,7 +910,7 @@ class QGaussPyramid : public Quadrature<dim>
   explicit QGaussPyramid(const unsigned int n_points_1D);
 };
 
-/*@}*/
+/** @} */
 
 /* -------------- declaration of explicit specializations ------------- */
 

include/deal.II/base/quadrature_point_data.h

@@ -38,8 +38,10 @@
 
 DEAL_II_NAMESPACE_OPEN
 
-/*!@addtogroup Quadrature */
-/*@{*/
+/**
+ * @addtogroup Quadrature
+ * @{
+ */
 
 /**
  * A class for storing at each cell represented by iterators of type @p CellIteratorType
@@ -587,7 +589,7 @@ namespace parallel
 
 #endif
 
-/*@}*/
+/** @} */
 
 #ifndef DOXYGEN
 

include/deal.II/base/quadrature_selector.h

@@ -87,7 +87,7 @@ class QuadratureSelector : public Quadrature<dim>
   DeclException1(ExcInvalidQuadrature,
                  std::string,
                  << arg1 << " is not a valid name for a quadrature rule.");
-  //@}
+  /** @} */
 private:
   /**
    * This static function creates a quadrature object according to the name

include/deal.II/base/subscriptor.h

@@ -106,8 +106,8 @@ class Subscriptor
    *
    * Classes derived from Subscriptor provide a facility to subscribe to this
    * object. This is mostly used by the SmartPointer class.
+   * @{
    */
-  // @{
 
   /**
    * Subscribes a user of the object by storing the pointer @p validity. The
@@ -148,7 +148,7 @@ class Subscriptor
   void
   list_subscribers() const;
 
-  // @}
+  /** @} */
 
   /**
    * @addtogroup Exceptions
@@ -181,7 +181,7 @@ class Subscriptor
                  << "No subscriber with identifier <" << arg2
                  << "> subscribes to this object of class " << arg1
                  << ". Consequently, it cannot be unsubscribed.");
-  //@}
+  /** @} */
 
   /**
    * Read or write the data of this object to or from a stream for the purpose

include/deal.II/base/table_handler.h

@@ -620,7 +620,7 @@ class TableHandler
                  << '<' << arg1 << "> is not a tex column format. Use "
                  << "'l', 'c', or 'r' to indicate left, centered, or "
                  << "right aligned text.");
-  //@}
+  /** @} */
 protected:
   /**
    * Structure encapsulating all the data that is needed to describe one

include/deal.II/base/tensor.h

@@ -1889,8 +1889,8 @@ constexpr unsigned int Tensor<rank_, dim, Number>::n_independent_components;
 
 /**
  * @name Output functions for Tensor objects
+ * @{
  */
-//@{
 
 /**
  * Output operator for tensors. Print the elements consecutively, with a space
@@ -1929,12 +1929,11 @@ operator<<(std::ostream &out, const Tensor<0, dim, Number> &p)
 }
 
 
-//@}
+/** @} */
 /**
  * @name Vector space operations on Tensor objects:
+ * @{
  */
-//@{
-
 
 /**
  * Scalar multiplication of a tensor of rank 0 with an object from the left.
@@ -2270,12 +2269,11 @@ inline constexpr DEAL_II_ALWAYS_INLINE
   return tmp;
 }
 
-//@}
+/** @} */
 /**
  * @name Contraction operations and the outer product for tensor objects
+ * @{
  */
-//@{
-
 
 /**
  * The dot product (single contraction) for tensors. This function return a
@@ -2613,12 +2611,11 @@ constexpr inline DEAL_II_ALWAYS_INLINE
 }
 
 
-//@}
+/** @} */
 /**
  * @name Special operations on tensors of rank 1
+ * @{
  */
-//@{
-
 
 /**
  * Return the cross product in 2d. This is just a rotation by 90 degrees
@@ -2677,12 +2674,11 @@ constexpr inline DEAL_II_ALWAYS_INLINE
 }
 
 
-//@}
+/** @} */
 /**
  * @name Special operations on tensors of rank 2
+ * @{
  */
-//@{
-
 
 /**
  * Compute the determinant of a tensor or rank 2.
@@ -3048,7 +3044,7 @@ linfty_norm(const Tensor<2, dim, Number> &t)
   return max;
 }
 
-//@}
+/** @} */
 
 
 #ifndef DOXYGEN

include/deal.II/base/tensor_function_parser.h

@@ -260,7 +260,7 @@ class TensorFunctionParser
                  << ") is not equal to the number of expressions (" << arg2
                  << ").");
 
-  //@}
+  /** @} */
 private:
   /**
    * Number of components is equal dim<sup>rank</sup>.

include/deal.II/base/thread_local_storage.h

@@ -31,8 +31,10 @@
 
 DEAL_II_NAMESPACE_OPEN
 
-/*!@addtogroup threads */
-/*@{*/
+/**
+ * @addtogroup threads
+ * @{
+ */
 
 #  ifndef DOXYGEN
 class LogStream;