[docs] Fix some Doxygen references

Cantera · Jul 24, 2023 · 153090d · 153090d
1 parent 1dbbf59
commit 153090d
Show file tree

Hide file tree

Showing 7 changed files with 14 additions and 12 deletions.
diff --git a/include/cantera/kinetics/KineticsFactory.h b/include/cantera/kinetics/KineticsFactory.h
@@ -41,7 +41,7 @@ class KineticsFactory : public Factory<Kinetics>
 
 /**
  *  Create a new kinetics manager.
- *  @deprecated  To be removed after Cantera 3.0; superseded by newKinetics.
+ *  @deprecated To be removed after %Cantera 3.0; superseded by newKinetics().
  */
 Kinetics* newKineticsMgr(const string& model);
 

diff --git a/include/cantera/numerics/Func1.h b/include/cantera/numerics/Func1.h
@@ -181,7 +181,7 @@ class Func1
     void setC(doublereal c);
 
     //! accessor function for m_f1
-    //! @deprecated To be removed after Cantera 3.0; replaced by func1_shared.
+    //! @deprecated To be removed after %Cantera 3.0; replaced by func1_shared().
     Func1& func1() const;
 
     //! Accessor function for m_f1_shared

diff --git a/include/cantera/oneD/Boundary1D.h b/include/cantera/oneD/Boundary1D.h
@@ -350,7 +350,7 @@ class ReactingSurf1D : public Boundary1D
 
     virtual void setKinetics(shared_ptr<Kinetics> kin);
 
-    //! @deprecated  To be removed after Cantera 3.0; replaced by setKinetics
+    //! @deprecated To be removed after %Cantera 3.0; replaced by setKinetics()
     void setKineticsMgr(InterfaceKinetics* kin);
 
     void enableCoverageEquations(bool docov) {

diff --git a/include/cantera/oneD/Domain1D.h b/include/cantera/oneD/Domain1D.h
@@ -340,7 +340,7 @@ class Domain1D
     /*!
      * @param soln local solution vector for this domain
      *
-     * @deprecated  To be removed after Cantera 3.0; superseded by asArray.
+     * @deprecated To be removed after %Cantera 3.0; superseded by asArray().
      */
     AnyMap serialize(const double* soln) const;
 
@@ -490,11 +490,11 @@ class Domain1D
         }
     }
 
-    //! @deprecated To be removed after Cantera 3.0; replaced by show
+    //! @deprecated To be removed after %Cantera 3.0; replaced by show()
     virtual void showSolution_s(std::ostream& s, const double* x);
 
     //! Print the solution.
-    //! @deprecated To be removed after Cantera 3.0; replaced by show
+    //! @deprecated To be removed after %Cantera 3.0; replaced by show()
     virtual void showSolution(const double* x);
 
     //! Print the solution.

diff --git a/include/cantera/oneD/Sim1D.h b/include/cantera/oneD/Sim1D.h
@@ -107,13 +107,13 @@ class Sim1D : public OneDim
     /**
      * Output information on current solution for all domains to stream.
      * @param s  Output stream
-     * @deprecated To be removed after Cantera 3.0; replaced by show
+     * @deprecated To be removed after %Cantera 3.0; replaced by show()
      */
     void showSolution(std::ostream& s);
 
     /**
      * Show logging information on current solution for all domains.
-     * @deprecated To be removed after Cantera 3.0; replaced by show
+     * @deprecated To be removed after %Cantera 3.0; replaced by show()
      */
     void showSolution();
 

diff --git a/include/cantera/oneD/StFlow.h b/include/cantera/oneD/StFlow.h
@@ -94,13 +94,15 @@ class StFlow : public Domain1D
     virtual void setKinetics(shared_ptr<Kinetics> kin);
 
     //! Set the kinetics manager.
-    //! @deprecated  To be removed after Cantera 3.0; replaced by Domain1D::setKinetics
+    //! @deprecated To be removed after %Cantera 3.0;
+    //!     replaced by Domain1D::setKinetics()
     void setKinetics(Kinetics& kin);
 
     virtual void setTransport(shared_ptr<Transport> trans);
 
     //! Set transport model to existing instance
-    //! @deprecated  To be removed after Cantera 3.0; replaced by Domain1D::setKinetics
+    //! @deprecated To be removed after %Cantera 3.0;
+    //!     replaced by Domain1D::setKinetics()
     void setTransport(Transport& trans);
 
     //! Set the transport model
@@ -204,7 +206,7 @@ class StFlow : public Domain1D
     //! Return the type of flow domain being represented, either "Free Flame" or
     //! "Axisymmetric Stagnation".
     //! @see setFreeFlow setAxisymmetricFlow
-    //! @deprecated  To be removed after Cantera 3.0; replaced by type.
+    //! @deprecated To be removed after %Cantera 3.0; replaced by type().
     virtual string flowType() const;
 
     void solveEnergyEqn(size_t j=npos);

diff --git a/include/cantera/zeroD/flowControllers.h b/include/cantera/zeroD/flowControllers.h
@@ -83,7 +83,7 @@ class PressureController : public FlowDevice
         m_primary = primary;
     }
 
-    //! @deprecated To be removed after Cantera 3.0; replaced by setPrimary.
+    //! @deprecated To be removed after %Cantera 3.0; replaced by setPrimary().
     void setMaster(FlowDevice* master);
 
     virtual void setTimeFunction(Func1* g) {