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

Eliminate infrequently used doxygen commenting style #1279

Merged
merged 2 commits into from
May 24, 2022

Conversation

ischoegl
Copy link
Member

@ischoegl ischoegl commented May 7, 2022

Changes proposed in this pull request

C++ doxygen documentation allows for several commenting styles. While other C and C++ styles are frequently used in the Cantera code base, the variant /// is used infrequently. In order to improve consistency, this PR eliminates /// in favor of the //! commenting variant.

I also noticed that /*! is much more frequently used than /**, but replacing the latter would be somewhat more intrusive.

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 streamline-doxygen-comments branch from 28ed22d to b9bcccb Compare May 7, 2022 16:14
@ischoegl ischoegl requested a review from a team May 7, 2022 16:38
@ischoegl
Copy link
Member Author

ischoegl commented May 9, 2022

Withdrawing - this is likely unnecessary churn.

@ischoegl ischoegl closed this May 9, 2022
@speth
Copy link
Member

speth commented May 9, 2022

I was going to merge this as soon as I'd had a chance to skim through it.

@ischoegl
Copy link
Member Author

ischoegl commented May 9, 2022

@speth ... feel free to reopen and merge - the branch is still active.

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.

Simple, and worth the little bit of extra consistency that helps identify what is and isn't a Doxygen comment.

@speth speth merged commit 06e89da into Cantera:main May 24, 2022
@ischoegl ischoegl deleted the streamline-doxygen-comments branch May 24, 2022 19:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants