[doxygen] Update formatting of remaining member groupings

Cantera · May 7, 2022 · 8cd7983 · 8cd7983
1 parent 2297bcb
commit 8cd7983
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 21 deletions.
diff --git a/include/cantera/oneD/Sim1D.h b/include/cantera/oneD/Sim1D.h
@@ -37,11 +37,9 @@ class Sim1D : public OneDim
      */
     Sim1D(std::vector<Domain1D*>& domains);
 
-    /**
-     * @name Setting initial values
-     *
-     * These methods are used to set the initial values of solution components.
-     */
+    //! @name Setting initial values
+    //!
+    //! These methods are used to set the initial values of solution components.
     //! @{
 
     /// Set initial guess for one component for all domains

diff --git a/include/cantera/oneD/StFlow.h b/include/cantera/oneD/StFlow.h
@@ -370,6 +370,7 @@ class StFlow : public Domain1D
     //! @}
 
     //! @name convective spatial derivatives.
+    //!
     //! These use upwind differencing, assuming u(z) is negative
     //! @{
     doublereal dVdz(const doublereal* x, size_t j) const {

diff --git a/include/cantera/transport/TransportBase.h b/include/cantera/transport/TransportBase.h
@@ -196,9 +196,7 @@ class Transport
     //! pointer.
     void checkSpeciesArraySize(size_t kk) const;
 
-    /**
-     * @name Transport Properties
-     */
+    //! @name Transport Properties
     //! @{
 
     /*!
@@ -576,7 +574,7 @@ class Transport
      * @param[in] ld  The dimension of the inner loop of d (usually equal to m_nsp)
      * @param[out] d  flat vector of diffusion coefficients, fortran ordering.
      *            d[ld*j+i] is the D_ij diffusion coefficient (the diffusion
-     *            coefficient for species i due to concentration gradients in 
+     *            coefficient for species i due to concentration gradients in
      *            species j). Units: m^2/s
      */
     virtual void getMultiDiffCoeffs(const size_t ld, doublereal* const d) {
@@ -715,11 +713,10 @@ class Transport
         return m_velocityBasis;
     }
 
-    /**
-     * @name Transport manager construction
-     * These methods are used during construction.
-     * @{
-     */
+    //! @name Transport manager construction
+    //!
+    //! These methods are used during construction.
+    //! @{
 
     //! Initialize a transport manager
     /*!

diff --git a/include/cantera/zeroD/ReactorBase.h b/include/cantera/zeroD/ReactorBase.h
@@ -78,7 +78,7 @@ class ReactorBase
         m_name = name;
     }
 
-    //! @name Methods to set up a simulation.
+    //! @name Methods to set up a simulation
     //! @{
 
     //! Set the initial reactor volume. By default, the volume is 1.0 m^3.
@@ -192,11 +192,10 @@ class ReactorBase
     //! on the outlet mass flow rates and the mass of the reactor contents.
     doublereal residenceTime();
 
-    /**
-     * @name Solution components.
-     * The values returned are those after the last call to ReactorNet::advance
-     * or ReactorNet::step.
-     */
+    //! @name Solution components
+    //!
+    //! The values returned are those after the last call to ReactorNet::advance
+    //! or ReactorNet::step.
     //! @{
 
     //! Returns the current volume (m^3) of the reactor.

diff --git a/include/cantera/zeroD/ReactorNet.h b/include/cantera/zeroD/ReactorNet.h
@@ -31,7 +31,7 @@ class ReactorNet : public FuncEval
     ReactorNet(const ReactorNet&) = delete;
     ReactorNet& operator=(const ReactorNet&) = delete;
 
-    //! @name Methods to set up a simulation.
+    //! @name Methods to set up a simulation
     //! @{
 
     //! Set initial time. Default = 0.0 s. Restarts integration from this time