[doxygen] Fix formatting of member groupings in kinetics docs

Cantera · May 7, 2022 · 7b2d495 · 7b2d495
1 parent 2bc0263
commit 7b2d495
Show file tree

Hide file tree

Showing 3 changed files with 48 additions and 52 deletions.
diff --git a/include/cantera/kinetics/GasKinetics.h b/include/cantera/kinetics/GasKinetics.h
@@ -91,11 +91,10 @@ class GasKinetics : public BulkKinetics
 
 protected:
     //! @name Internal service methods
-    /*!
-     * These methods are for @internal use, and seek to avoid code duplication
-     * while evaluating terms used for rate constants, rates of progress, and
-     * their derivatives.
-     */
+    //!
+    //! These methods are for @internal use, and seek to avoid code duplication
+    //! while evaluating terms used for rate constants, rates of progress, and
+    //! their derivatives.
     //! @{
 
     //! Calculate rate coefficients
@@ -170,7 +169,8 @@ class GasKinetics : public BulkKinetics
     Rate1<ChebyshevRate> m_cheb_rates; //!< @deprecated (legacy only)
 
     //! @name Reaction rate data
-    //!@{
+    //! @{
+
     doublereal m_logStandConc;
     vector_fp m_rfn_low; //!< @deprecated (legacy only)
     vector_fp m_rfn_high; //!< @deprecated (legacy only)
@@ -180,7 +180,7 @@ class GasKinetics : public BulkKinetics
     vector_fp concm_3b_values; //!< @deprecated (legacy only)
     vector_fp concm_falloff_values; //!< @deprecated (legacy only)
 
-    //!@}
+    //! @}
 
     //! Buffers for partial rop results with length nReactions()
     vector_fp m_rbuf0;

diff --git a/include/cantera/kinetics/Kinetics.h b/include/cantera/kinetics/Kinetics.h
@@ -569,31 +569,30 @@ class Kinetics
 
     //! @}
     //! @name Routines to Calculate Derivatives (Jacobians)
-    /*!
-     * Derivatives are calculated with respect to temperature, pressure, molar
-     * concentrations and species mole fractions for forward/reverse/net rates of
-     * progress as well as creation/destruction and net production of species.
-     *
-     * The following suffixes are used to indicate derivatives:
-     *  - `_ddT`: derivative with respect to temperature (a vector)
-     *  - `_ddP`: derivative with respect to pressure (a vector)
-     *  - `_ddC`: derivative with respect to molar concentration (a vector)
-     *  - `_ddX`: derivative with respect to species mole fractions (a matrix)
-     *
-     * Settings for derivative evaluation are set by keyword/value pairs using
-     * the methods @see getDerivativeSettings and @see setDerivativeSettings.
-     *
-     * For GasKinetics, the following keyword/value pairs are supported:
-     *  - `skip-third-bodies` (boolean) ... if `false` (default), third body
-     *    concentrations are considered for the evaluation of jacobians
-     *  - `skip-falloff` (boolean) ... if `false` (default), third-body effects
-     *    on rate constants are considered for the evaluation of derivatives.
-     *  - `rtol-delta` (double) ... relative tolerance used to perturb properties
-     *    when calculating numerical derivatives. The default value is 1e-8.
-     *
-     * @warning  The calculation of derivatives is an experimental part of the
-     *      %Cantera API and may be changed or removed without notice.
-     */
+    //!
+    //! Derivatives are calculated with respect to temperature, pressure, molar
+    //! concentrations and species mole fractions for forward/reverse/net rates of
+    //! progress as well as creation/destruction and net production of species.
+    //!
+    //! The following suffixes are used to indicate derivatives:
+    //!  - `_ddT`: derivative with respect to temperature (a vector)
+    //!  - `_ddP`: derivative with respect to pressure (a vector)
+    //!  - `_ddC`: derivative with respect to molar concentration (a vector)
+    //!  - `_ddX`: derivative with respect to species mole fractions (a matrix)
+    //!
+    //! Settings for derivative evaluation are set by keyword/value pairs using
+    //! the methods @see getDerivativeSettings and @see setDerivativeSettings.
+    //!
+    //! For GasKinetics, the following keyword/value pairs are supported:
+    //!  - `skip-third-bodies` (boolean) ... if `false` (default), third body
+    //!    concentrations are considered for the evaluation of jacobians
+    //!  - `skip-falloff` (boolean) ... if `false` (default), third-body effects
+    //!    on rate constants are considered for the evaluation of derivatives.
+    //!  - `rtol-delta` (double) ... relative tolerance used to perturb properties
+    //!    when calculating numerical derivatives. The default value is 1e-8.
+    //!
+    //! @warning  The calculation of derivatives is an experimental part of the
+    //!      %Cantera API and may be changed or removed without notice.
     //! @{
 
     /**
@@ -1189,15 +1188,14 @@ class Kinetics
 
     //! @}
     //! @name Altering Reaction Rates
-    /*!
-     * These methods alter reaction rates. They are designed primarily for
-     * carrying out sensitivity analysis, but may be used for any purpose
-     * requiring dynamic alteration of rate constants. For each reaction, a
-     * real-valued multiplier may be defined that multiplies the reaction rate
-     * coefficient. The multiplier may be set to zero to completely remove a
-     * reaction from the mechanism.
-     * @{
-     */
+    //!
+    //! These methods alter reaction rates. They are designed primarily for
+    //! carrying out sensitivity analysis, but may be used for any purpose
+    //! requiring dynamic alteration of rate constants. For each reaction, a
+    //! real-valued multiplier may be defined that multiplies the reaction rate
+    //! coefficient. The multiplier may be set to zero to completely remove a
+    //! reaction from the mechanism.
+    //! @{
 
     //! The current value of the multiplier for reaction i.
     /*!
@@ -1289,12 +1287,11 @@ class Kinetics
     void checkReactionBalance(const Reaction& R);
 
     //! @name Stoichiometry management
-    /*!
-     *  These objects and functions handle turning reaction extents into species
-     *  production rates and also handle turning thermo properties into reaction
-     *  thermo properties.
-     *  @{
-     */
+    //!
+    //! These objects and functions handle turning reaction extents into species
+    //! production rates and also handle turning thermo properties into reaction
+    //! thermo properties.
+    //! @{
 
     //! Stoichiometry manager for the reactants for each reaction
     StoichManagerN m_reactantStoich;

diff --git a/include/cantera/kinetics/ReactionPath.h b/include/cantera/kinetics/ReactionPath.h
@@ -39,11 +39,10 @@ class SpeciesNode
     doublereal value; ///< May be used to set node appearance
     bool visible; ///< Visible on graph;
 
-    /**
-     *  @name References.
-     * Return a reference to a path object connecting this node
-     *  to another node.
-     */
+    //! @name References
+    //!
+    //! Return a reference to a path object connecting this node
+    //! to another node.
     //! @{
     Path* path(int n) {
         return m_paths[n];