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

Fix member groupings in doxygen #1276

Merged
merged 4 commits into from
May 7, 2022
Merged

Conversation

ischoegl
Copy link
Member

@ischoegl ischoegl commented May 6, 2022

Changes proposed in this pull request

  • Update formatting of doxygen member groupings
  • Update formatting of doxygen module groupings

Per #1275, there are two working formatting variants of member grouping commonly found (while others don't work and don't produce the expected output). This PR consistently applies the following

\\! @name GroupName
\\! description of the grouping
\\! @{
[...]
\\! @}

If applicable, fill in the issue number this pull request is fixing

Closes #1275

If applicable, provide an example illustrating new features this pull request is introducing

Checklist

  • The pull request includes a clear description of this code change
  • Commit messages have short titles and reference relevant issues
  • Build passes (scons build & scons test) and unit tests address code coverage
  • Style & formatting of contributed code follows contributing guidelines
  • The pull request is ready for review

@ischoegl ischoegl force-pushed the fix-member-groupings branch 2 times, most recently from 79de571 to acbd4a5 Compare May 6, 2022 02:36
@ischoegl ischoegl requested a review from a team May 6, 2022 03:22
@ischoegl ischoegl changed the title Fix member groupings Fix member groupings in doxygen May 6, 2022
Copy link
Member

@speth speth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for working through this, @ischoegl. I know this kind of comment reformatting can be a bit tedious. I had only a couple spots where I think there were some additional things worth cleaning up.

include/cantera/thermo/DebyeHuckel.h Outdated Show resolved Hide resolved
include/cantera/thermo/MargulesVPSSTP.h Outdated Show resolved Hide resolved
include/cantera/thermo/MixtureFugacityTP.h Outdated Show resolved Hide resolved
include/cantera/thermo/PDSS.h Outdated Show resolved Hide resolved
@ischoegl
Copy link
Member Author

ischoegl commented May 7, 2022

@speth ... done. It was tedious, but searching for @name in VSCode is actually not too bad.

@ischoegl ischoegl requested a review from speth May 7, 2022 02:41
@ischoegl
Copy link
Member Author

ischoegl commented May 7, 2022

Ended up taking care of module groupings also, so every grouping is now formatted consistently

Copy link
Member

@speth speth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @ischoegl. Hopefully, having the existing style for these be consistent will encourage consistent usage in the future as well.

@speth speth merged commit e5122f0 into Cantera:main May 7, 2022
@ischoegl ischoegl deleted the fix-member-groupings branch May 7, 2022 15:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Doxygen member groupings formatted incorrectly
2 participants