You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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 intGroup and @defgroup relatedProps define no methods/classes.
@defgroup solvesp_methods and @defgroup solvesp_bulkFunc add 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
The text was updated successfully, but these errors were encountered:
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 physConstants
misses most defined constants (proposed resolution in Update doxygen Chemical Kinetics/Numerics Documentation #1534)@defgroup intGroup
and@defgroup relatedProps
define no methods/classes.@defgroup solvesp_methods
and@defgroup solvesp_bulkFunc
add 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
The text was updated successfully, but these errors were encountered: