[Doc] Fix some Doxygen warnings

Cantera · Apr 19, 2023 · 68c463f · 68c463f
1 parent f6c8c0e
commit 68c463f
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 5 deletions.
diff --git a/include/cantera/base/ExtensionManager.h b/include/cantera/base/ExtensionManager.h
@@ -92,6 +92,8 @@ class ExtensionManager
     //! @param rateName  The name of the reaction rate type
     //! @param wrapperName  The name used for Solution wrappers to be used with this
     //!     object, corresponding to a type registered with registerSolutionLinker().
+    //! @param link  Function that creates ReactionData wrapper and links it to the
+    //!     provided C++ object
     static void registerReactionDataLinker(const string& rateName,
         const string& wrapperName, function<void(ReactionDataDelegator&)> link);
 

diff --git a/include/cantera/base/SolutionArray.h b/include/cantera/base/SolutionArray.h
@@ -285,6 +285,7 @@ class SolutionArray
      *
      *  @param fname  Name of container file (YAML or HDF)
      *  @param id  Identifier of SolutionArray within the container file
+     *  @param sub  Name of the subgroup holding actual data
      */
     AnyMap restore(const string& fname, const string& id, const string& sub);
 

diff --git a/include/cantera/kinetics/Kinetics.h b/include/cantera/kinetics/Kinetics.h
@@ -607,10 +607,10 @@ class Kinetics
     //!
     //! For InterfaceKinetics, the following keyword/value pairs are supported:
     //!  - `skip-coverage-dependence` (boolean) ... if `false` (default), rate constant
-    //!   coverage dependence is not considered when evaluating derivatives.
-    //! - `skip-electrochemistry` (boolean) ... if `false` (default), electrical charge
-    //!   is not considered in evaluating the derivatives and these reactions are
-    //!   treated as normal surface reactions.
+    //!    coverage dependence is not considered when evaluating derivatives.
+    //!  - `skip-electrochemistry` (boolean) ... if `false` (default), electrical charge
+    //!    is not considered in evaluating the derivatives and these reactions are
+    //!    treated as normal surface reactions.
     //!  - `rtol-delta` (double) ... relative tolerance used to perturb properties
     //!    when calculating numerical derivatives. The default value is 1e-8.
     //!

diff --git a/include/cantera/kinetics/KineticsFactory.h b/include/cantera/kinetics/KineticsFactory.h
@@ -65,7 +65,7 @@ shared_ptr<Kinetics> newKinetics(const vector<shared_ptr<ThermoPhase>>& phases,
                                  const AnyMap& rootNode=AnyMap(),
                                  shared_ptr<Solution> soln={});
 
-//! @copydoc newKinetics(const vector<shared_ptr<ThermoPhase>>&, const AnyMap&, const AnyMap&)
+//! @see newKinetics(const vector<shared_ptr<ThermoPhase>>&, const AnyMap&, const AnyMap&, shared_ptr<Solution>)
 //! @deprecated  To be removed after Cantera 3.0;
 //!     superseded by newKinetics() returning shared_ptr
 unique_ptr<Kinetics> newKinetics(const std::vector<ThermoPhase*>& phases,