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

Doxygen cleanup #1567

Merged
merged 8 commits into from
Aug 6, 2023
Merged

Doxygen cleanup #1567

merged 8 commits into from
Aug 6, 2023

Conversation

ischoegl
Copy link
Member

@ischoegl ischoegl commented Aug 3, 2023

Changes proposed in this pull request

This PR collects final doxygen cleanup steps in the context of Cantera/enhancements#179

  • Sort BibTeX file alphabetically to reduce future merge conflicts.
  • Replace remaining single-letter Doxygen commands \a, \b, \c, \e, \p by @b, @c and @e
  • Fix some LaTeX issues

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

Closes Cantera/enhancements#179

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 doxygen-cleanup branch 2 times, most recently from 00d340d to ab46df9 Compare August 3, 2023 17:58
@ischoegl ischoegl marked this pull request as ready for review August 3, 2023 20:01
@ischoegl ischoegl requested a review from a team August 3, 2023 20:01
@ischoegl ischoegl changed the title [WIP] Doxygen cleanup Doxygen cleanup Aug 3, 2023
@ischoegl
Copy link
Member Author

ischoegl commented Aug 4, 2023

@speth ... while there is clearly more potential for improvement, I am starting to see diminishing returns. Anything beyond can wait until after Cantera 3.0.

@ischoegl
Copy link
Member Author

ischoegl commented Aug 4, 2023

Rebased. Merge conflicts should (hopefully) wash out soon.

@ischoegl ischoegl mentioned this pull request Aug 5, 2023
5 tasks
@ischoegl
Copy link
Member Author

ischoegl commented Aug 5, 2023

@speth ... resolved merge conflicts, so this is ready for a review.

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.

In the long run, I think I might prefer Markdown-style formatting over the Doxygen-specific @e, @c etc, but this is fine for now.

include/cantera/thermo/IdealSolidSolnPhase.h Outdated Show resolved Hide resolved
@ischoegl ischoegl requested a review from speth August 6, 2023 14:14
@ischoegl ischoegl merged commit 38b76a0 into Cantera:main Aug 6, 2023
42 checks passed
@ischoegl ischoegl deleted the doxygen-cleanup branch August 6, 2023 14:31
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 this pull request may close these issues.

Use Doxygen effectively
2 participants