More doxygen fixes

Cantera · Oct 24, 2023 · 1c005f9 · 1c005f9
1 parent b4fac3a
commit 1c005f9
Show file tree

Hide file tree

Showing 3 changed files with 95 additions and 82 deletions.
diff --git a/include/cantera/zeroD/FlowDevice.h b/include/cantera/zeroD/FlowDevice.h
@@ -115,40 +115,47 @@ class FlowDevice
         m_time = time;
     }
 
-    /*! Build the Jacobian terms specific to the flow device for the given connected reactor.
-     * @param r a pointer to the calling reactor
-     * @param jacVector a vector of triplets to be added to the jacobian for the reactor
-     * @warning This function is an experimental part of the %Cantera API and may be changed
-     * or removed without notice.
-     * @since New in %Cantera 3.0.
-     */
+    //! Build the Jacobian terms specific to the flow device for the given connected
+    //! reactor.
+    //! @param r a pointer to the calling reactor
+    //! @param jacVector a vector of triplets to be added to the jacobian for the
+    //! reactor
+    //! @warning This function is an experimental part of the %Cantera API and may be
+    //! changed
+    //! or removed without notice.
+    //! @since New in %Cantera 3.0.
+    //!
     virtual void buildReactorJacobian(ReactorBase* r, vector<Eigen::Triplet<double>>& jacVector) {
         throw NotImplementedError(type() + "::buildReactorJacobian");
     }
 
-    /*! Build the Jacobian terms specific to the flow device for the network. These terms
-     * will be adjusted to the networks indexing system outside of the reactor.
-     * @param jacVector a vector of triplets to be added to the jacobian for the reactor
-     * @warning This function is an experimental part of the %Cantera API and may be changed
-     * or removed without notice.
-     * @since New in %Cantera 3.0.
-     */
+    //! Build the Jacobian terms specific to the flow device for the network. These
+    //! terms
+    //! will be adjusted to the networks indexing system outside of the reactor.
+    //! @param jacVector a vector of triplets to be added to the jacobian for the
+    //! reactor
+    //! @warning This function is an experimental part of the %Cantera API and may be
+    //! changed
+    //! or removed without notice.
+    //! @since New in %Cantera 3.0.
+    //!
     virtual void buildNetworkJacobian(vector<Eigen::Triplet<double>>& jacVector) {
         throw NotImplementedError(type() + "::buildNetworkJacobian");
     }
 
-    /*! Specify the jacobian terms have been calculated and should not be recalculated.
-     * @warning This function is an experimental part of the %Cantera API and may be changed
-     * or removed without notice.
-     * @since New in %Cantera 3.0.
-     */
+    //! Specify the jacobian terms have been calculated and should not be recalculated.
+    //! @warning This function is an experimental part of the %Cantera API and may be
+    //! changed
+    //! or removed without notice.
+    //! @since New in %Cantera 3.0.
+    //!
     void jacobianCalculated() { m_jac_calculated = true; };
 
-    /*! Specify that jacobian terms have not been calculated and should be recalculated.
-     * @warning This function is an experimental part of the %Cantera API and may be changed
-     * or removed without notice.
-     * @since New in %Cantera 3.0.
-     */
+    //! Specify that jacobian terms have not been calculated and should be recalculated.
+    //! @warning This function is an experimental part of the %Cantera API and may be changed
+    //! or removed without notice.
+    //! @since New in %Cantera 3.0.
+    //!
     void jacobianNotCalculated() { m_jac_calculated = false; };
 
 protected:

diff --git a/include/cantera/zeroD/ReactorBase.h b/include/cantera/zeroD/ReactorBase.h
@@ -248,48 +248,50 @@ class ReactorBase
     //! Set the ReactorNet that this reactor belongs to.
     void setNetwork(ReactorNet* net);
 
-    /*! Calculate the derivative of temperature with respect to the temperature in the
-     * heat transfer equation based on the reactor specific equation of state.
-     * This function should also transform the state of the derivative to that
-     * appropriate for the jacobian's state/
-     * @warning This function is an experimental part of the %Cantera API and may be changed
-     * or removed without notice.
-     * @since New in %Cantera 3.0.
-     */
+    //! Calculate the derivative of temperature with respect to the temperature in the
+    //! heat transfer equation based on the reactor specific equation of state.
+    //! This function should also transform the state of the derivative to that
+    //! appropriate for the jacobian's state/
+    //! @warning This function is an experimental part of the %Cantera API and may be changed
+    //! or removed without notice.
+    //! @since New in %Cantera 3.0.
+    //!
     virtual double temperatureDerivative() {
         throw NotImplementedError("Reactor::temperatureDerivative");
     }
 
-    /*! Calculate the derivative of temperature with respect to the temperature in the
-     * heat transfer radiation equation based on the reactor specific equation of state.
-     * This function should also transform the state of the derivative to that
-     * appropriate for the jacobian's state/
-     * @warning This function is an experimental part of the %Cantera API and may be changed
-     * or removed without notice.
-     * @since New in %Cantera 3.0.
-     */
+    //! Calculate the derivative of temperature with respect to the temperature in the
+    //! heat transfer radiation equation based on the reactor specific equation of
+    //! state.
+    //! This function should also transform the state of the derivative to that
+    //! appropriate for the jacobian's state/
+    //! @warning This function is an experimental part of the %Cantera API and may be
+    //! changed
+    //! or removed without notice.
+    //! @since New in %Cantera 3.0.
+    //!
     virtual double temperatureRadiationDerivative() {
         throw NotImplementedError("Reactor::temperatureRadiationDerivative");
     }
 
-    /*! Calculate the derivative of T with respect to the ith species in the heat
-     * transfer equation based on the reactor specific equation of state.
-     * @param index index of the species the derivative is with respect too
-     * @warning This function is an experimental part of the %Cantera API and may be changed
-     * or removed without notice.
-     * @since New in %Cantera 3.0.
-     */
+    //! Calculate the derivative of T with respect to the ith species in the heat
+    //! transfer equation based on the reactor specific equation of state.
+    //! @param index index of the species the derivative is with respect too
+    //! @warning This function is an experimental part of the %Cantera API and may be changed
+    //! or removed without notice.
+    //! @since New in %Cantera 3.0.
+    //!
     virtual double moleDerivative(size_t index) {
         throw NotImplementedError("Reactor::moleDerivative");
     }
 
-    /*! Calculate the derivative of T with respect to the ith species in the heat
-     * transfer radiation equation based on the reactor specific equation of state.
-     * @param index index of the species the derivative is with respect too
-     * @warning This function is an experimental part of the %Cantera API and may be changed
-     * or removed without notice.
-     * @since New in %Cantera 3.0.
-     */
+    //! Calculate the derivative of T with respect to the ith species in the heat
+    //! transfer radiation equation based on the reactor specific equation of state.
+    //! @param index index of the species the derivative is with respect too
+    //! @warning This function is an experimental part of the %Cantera API and may be changed
+    //! or removed without notice.
+    //! @since New in %Cantera 3.0.
+    //!
     virtual double moleRadiationDerivative(size_t index) {
         throw NotImplementedError("Reactor::moleRadiationDerivative");
     }

diff --git a/include/cantera/zeroD/Wall.h b/include/cantera/zeroD/Wall.h
@@ -116,44 +116,48 @@ class WallBase
         m_time = time;
     }
 
-    /*! Build the Jacobian terms specific to the flow device for the given connected reactor.
-     * @param r a pointer to the calling reactor
-     * @param jacVector a vector of triplets to be added to the jacobian for the reactor
-     * @warning This function is an experimental part of the %Cantera API and may be
-     * changed
-     * or removed without notice.
-     * @since New in %Cantera 3.0.
-     */
+    //! Build the Jacobian terms specific to the flow device for the given connected
+    //! reactor.
+    //! @param r a pointer to the calling reactor
+    //! @param jacVector a vector of triplets to be added to the jacobian for the
+    //! reactor
+    //! @warning This function is an experimental part of the %Cantera API and may be
+    //! changed
+    //! or removed without notice.
+    //! @since New in %Cantera 3.0.
+    //!
     virtual void buildReactorJacobian(ReactorBase* r, vector<Eigen::Triplet<double>>& jacVector) {
         throw NotImplementedError("WallBase::buildReactorJacobian");
     }
 
-    /*! Build the Jacobian terms specific to the flow device for the network. These terms
-     * will be adjusted to the networks indexing system outside of the reactor.
-     * @param jacVector a vector of triplets to be added to the jacobian for the reactor
-     * @warning This function is an experimental part of the %Cantera API and may be
-     * changed
-     * or removed without notice.
-     * @since New in %Cantera 3.0.
-     */
+    //! Build the Jacobian terms specific to the flow device for the network. These
+    //! terms
+    //! will be adjusted to the networks indexing system outside of the reactor.
+    //! @param jacVector a vector of triplets to be added to the jacobian for the
+    //! reactor
+    //! @warning This function is an experimental part of the %Cantera API and may be
+    //! changed
+    //! or removed without notice.
+    //! @since New in %Cantera 3.0.
+    //!
     virtual void buildNetworkJacobian(vector<Eigen::Triplet<double>>& jacVector) {
         throw NotImplementedError("WallBase::buildNetworkJacobian");
     }
 
-    /*! Specify the jacobian terms have been calculated and should not be recalculated.
-     * @warning This function is an experimental part of the %Cantera API and may be
-     * changed
-     * or removed without notice.
-     * @since New in %Cantera 3.0.
-     */
+    //! Specify the jacobian terms have been calculated and should not be recalculated.
+    //! @warning This function is an experimental part of the %Cantera API and may be
+    //! changed
+    //! or removed without notice.
+    //! @since New in %Cantera 3.0.
+    //!
     void jacobianCalculated() { m_jac_calculated = true; };
 
-    /*! Specify that jacobian terms have not been calculated and should be recalculated.
-     * @warning This function is an experimental part of the %Cantera API and may be
-     * changed
-     * or removed without notice.
-     * @since New in %Cantera 3.0.
-     */
+    //! Specify that jacobian terms have not been calculated and should be recalculated.
+    //! @warning This function is an experimental part of the %Cantera API and may be
+    //! changed
+    //! or removed without notice.
+    //! @since New in %Cantera 3.0.
+    //!
     void jacobianNotCalculated() { m_jac_calculated = false; };
 
 protected: