Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing doxygen groupings #1535

Closed
3 tasks done
ischoegl opened this issue Jul 7, 2023 · 0 comments · Fixed by #1543
Closed
3 tasks done

Missing doxygen groupings #1535

ischoegl opened this issue Jul 7, 2023 · 0 comments · Fixed by #1543

Comments

@ischoegl
Copy link
Member

ischoegl commented Jul 7, 2023

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
ischoegl added a commit to ischoegl/cantera that referenced this issue Jul 17, 2023
ischoegl added a commit to ischoegl/cantera that referenced this issue Jul 17, 2023
ischoegl added a commit to ischoegl/cantera that referenced this issue Jul 17, 2023
ischoegl added a commit that referenced this issue Jul 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Development

Successfully merging a pull request may close this issue.

1 participant