Eliminate infrequently used doxygen commenting style #1279
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
scons build
&scons test
) and unit tests address code coverage