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 autobrief fixes #1561

Merged
merged 8 commits into from Aug 3, 2023
Merged

Doxygen autobrief fixes #1561

merged 8 commits into from Aug 3, 2023

Conversation

ischoegl
Copy link
Member

@ischoegl ischoegl commented Jul 29, 2023

Changes proposed in this pull request

Fix instances where intended autobrief documentation was not rendered correctly. This mostly affects newer documentation.

Also, add some citations.

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

Closes #1560 / partially addresses 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

@codecov
Copy link

codecov bot commented Jul 29, 2023

Codecov Report

Merging #1561 (8ebc03a) into main (e2e5e1b) will increase coverage by 0.01%.
Report is 6 commits behind head on main.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #1561      +/-   ##
==========================================
+ Coverage   70.45%   70.47%   +0.01%     
==========================================
  Files         379      379              
  Lines       59093    59093              
  Branches    21230    21230              
==========================================
+ Hits        41636    41643       +7     
+ Misses      14376    14369       -7     
  Partials     3081     3081              
Files Changed Coverage Δ
include/cantera/base/SolutionArray.h 94.44% <ø> (ø)
include/cantera/base/ValueCache.h 100.00% <ø> (ø)
include/cantera/base/ctexceptions.h 60.86% <ø> (ø)
include/cantera/base/global.h 81.81% <ø> (ø)
include/cantera/base/utilities.h 96.66% <ø> (ø)
include/cantera/equil/ChemEquil.h 100.00% <ø> (ø)
include/cantera/equil/MultiPhaseEquil.h 90.47% <ø> (ø)
include/cantera/equil/vcs_species_thermo.h 100.00% <ø> (ø)
include/cantera/kinetics/ImplicitSurfChem.h 100.00% <ø> (ø)
include/cantera/kinetics/Kinetics.h 32.66% <ø> (ø)
... and 38 more

... and 2 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@ischoegl ischoegl force-pushed the doxygen-autobrief branch 3 times, most recently from a400049 to 5a4e8e9 Compare July 29, 2023 14:49
@ischoegl ischoegl marked this pull request as ready for review July 29, 2023 15:03
@ischoegl ischoegl requested a review from a team July 29, 2023 15:03
@ischoegl ischoegl changed the title Doxygen autobrief Doxygen autobrief fixes Jul 30, 2023
@ischoegl ischoegl force-pushed the doxygen-autobrief branch 3 times, most recently from 87abc3b to f843391 Compare August 3, 2023 02:51
@ischoegl ischoegl force-pushed the doxygen-autobrief branch 2 times, most recently from 6657b32 to 1bac831 Compare August 3, 2023 11:34
@speth speth removed the request for review from a team August 3, 2023 12:51
@speth
Copy link
Member

speth commented Aug 3, 2023

@ischoegl - I dismissed the review request since this branch keeps changing. Please re-request a review when you're finished here.

@ischoegl ischoegl requested a review from speth August 3, 2023 13:44
@ischoegl
Copy link
Member Author

ischoegl commented Aug 3, 2023

Should be done now. If I find anything else, I’ll attach it elsewhere.

include/cantera/base/SolutionArray.h Outdated Show resolved Hide resolved
include/cantera/base/SolutionArray.h Outdated Show resolved Hide resolved
include/cantera/base/SolutionArray.h Outdated Show resolved Hide resolved
src/thermo/WaterPropsIAPWS.cpp Outdated Show resolved Hide resolved
@ischoegl
Copy link
Member Author

ischoegl commented Aug 3, 2023

Thanks, @speth - this should be ready to merge.

@ischoegl ischoegl merged commit 3478d0e into Cantera:main Aug 3, 2023
41 checks passed
@ischoegl ischoegl deleted the doxygen-autobrief branch August 3, 2023 17:58
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.

Doxygen autobrief does not work for /*!
2 participants