Doxygen formatting #1557
Merged
Doxygen formatting #1557
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
10 tasks
5 tasks
Codecov Report
@@ Coverage Diff @@
## main #1557 +/- ##
==========================================
- Coverage 70.48% 70.47% -0.02%
==========================================
Files 379 379
Lines 59093 59093
Branches 21230 21230
==========================================
- Hits 41653 41643 -10
- Misses 14360 14369 +9
- Partials 3080 3081 +1
... and 3 files with indirect coverage changes 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
Writing %Cantera rather than Cantera in Doxygen docstrings avoids creating a link to the Cantera namespace in the generated documentation.
Use @ref rather than \ref for all cross-references (about half of the references used one or the other style); also, replace backslash in a couple of other less commonly used Doxygen commands.
speth
approved these changes
Aug 1, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
CONTRIBUTING.md@refcommand (about half of instances used\ref)\to@for less commonly used Doxygen commandsDoxygen supports commands that either start with
\or@. As the former is also used for LaTeX, using the latter will better differentiate syntax. It is noted that this PR does not replace instances of\f[/\f]and\f$, as this would create significantly more churn (see #1558).As an aside, there is a good "perfectionist" Doxygen style guide here. Note that I don't think it makes sense to be this rigid, but it was interesting enough to post a link here.
If applicable, fill in the issue number this pull request is fixing
Partially Cantera/enhancements#179
Checklist
scons build&scons test) and unit tests address code coverage