From 6d25e890d85430818fda78778b223a1343345513 Mon Sep 17 00:00:00 2001 From: Ingmar Schoegl Date: Mon, 17 Jul 2023 11:59:32 -0600 Subject: [PATCH] [docs] Resolve #1535 --- include/cantera/base/clockWC.h | 2 ++ include/cantera/base/stringUtils.h | 7 +++++++ include/cantera/kinetics/EdgeKinetics.h | 2 -- include/cantera/numerics/Integrator.h | 8 ++++---- 4 files changed, 13 insertions(+), 6 deletions(-) diff --git a/include/cantera/base/clockWC.h b/include/cantera/base/clockWC.h index 07decb959b4..d4c17e9a35f 100644 --- a/include/cantera/base/clockWC.h +++ b/include/cantera/base/clockWC.h @@ -14,6 +14,8 @@ namespace Cantera { +//! @defgroup globalUtilFuncs Global Utility Functions + //! The class provides the wall clock timer in seconds /*! * This routine relies on the ANSI C routine, clock(), for its basic operation. diff --git a/include/cantera/base/stringUtils.h b/include/cantera/base/stringUtils.h index eb343eeeb16..092b55cd149 100644 --- a/include/cantera/base/stringUtils.h +++ b/include/cantera/base/stringUtils.h @@ -14,6 +14,11 @@ namespace Cantera { +//! @defgroup StringConversion String Conversion +//! Utility functions for conversion of formatted strings. +//! @ingroup globalUtilFuncs +//! @{ + //! Convert a vector to a string (separated by commas) /*! * @param v vector to be converted @@ -142,6 +147,8 @@ std::string toLowerCopy(const std::string& input); */ bool caseInsensitiveEquals(const std::string &input, const std::string &test); +//! @} + } #endif diff --git a/include/cantera/kinetics/EdgeKinetics.h b/include/cantera/kinetics/EdgeKinetics.h index b2dd471c47b..ae4d675f7b1 100644 --- a/include/cantera/kinetics/EdgeKinetics.h +++ b/include/cantera/kinetics/EdgeKinetics.h @@ -1,7 +1,5 @@ /** * @file EdgeKinetics.h - * - * @ingroup electrochem */ // This file is part of Cantera. See License.txt in the top-level directory or diff --git a/include/cantera/numerics/Integrator.h b/include/cantera/numerics/Integrator.h index 8b519494f0e..2ccb35376fc 100644 --- a/include/cantera/numerics/Integrator.h +++ b/include/cantera/numerics/Integrator.h @@ -2,10 +2,6 @@ * @file Integrator.h */ -/** - * @defgroup intGroup Integrators for initial value problems - */ - // This file is part of Cantera. See License.txt in the top-level directory or // at https://cantera.org/license.txt for license and copyright information. @@ -335,6 +331,10 @@ class Integrator }; // defined in Integrators.cpp + +//! Create new Integrator object +//! @param itype Integration mode; either \c CVODE or \c IDA +//! @ingroup odeGroup Integrator* newIntegrator(const std::string& itype); } // namespace