Skip to content

Missing doxygen groupings #1535

@ischoegl

Description

@ischoegl

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:

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

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions