-
-
Notifications
You must be signed in to change notification settings - Fork 409
Closed
Labels
Description
Problem description
While Cantera's C++ core provides detailed information on classes and functions, many classes and functions lack @ingroup labels that would generate convenient structures of the doxygen-generated HTML pages, specifically the Modules tab.
For others, @ingroup are defined, but there is no associated @defgroup. Examples are:
@ingroup electrochem@ingroup odeGroup@ingroup globalUtilFuncs
Beyond, the generated output may often not be what was intended:
-
@defgroup physConstantsmisses most defined constants (proposed resolution in Update doxygen Chemical Kinetics/Numerics Documentation #1534) -
@defgroup intGroupand@defgroup relatedPropsdefine no methods/classes. -
@defgroup solvesp_methodsand@defgroup solvesp_bulkFuncadd no useful information.
In either case, the list is likely incomplete.
As an aside, some of the newer Cantera capabilities do not show up in the Modules drop-down (example: AnyValue / AnyMap), and some of the groupings could be better structured.
System information
- Cantera version: 3.0.0b1
Reactions are currently unavailable