-
-
Notifications
You must be signed in to change notification settings - Fork 349
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
Update doxygen Chemical Kinetics/Numerics Documentation #1534
Conversation
Codecov Report
@@ Coverage Diff @@
## main #1534 +/- ##
=======================================
Coverage 70.50% 70.50%
=======================================
Files 376 376
Lines 59075 59081 +6
Branches 21219 21222 +3
=======================================
+ Hits 41649 41657 +8
+ Misses 14348 14344 -4
- Partials 3078 3080 +2
... and 3 files with indirect coverage changes 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
ea25789
to
ee55684
Compare
1bd2361
to
2c7b471
Compare
@speth ... I am stopping here. I think that navigating the "C++ Modules" structure has become a bit easier and I also started to fill in some gaps. I have made no attempts to update sections on integrators, phases, oneD and zeroD, or some of the ungrouped Cantera capabilities. The PR targets the structure and should help locating information based on a handful of topics. Revising of actual docstrings goes beyond the scope of the PR. |
040bad6
to
59ee816
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for working on this, @ischoegl. I think the new landing page is a much friendlier alternative to the essentially blank page that's there now. I have only a few minor suggestions.
Supported for doxygen 1.8.3 and later (released 2012)
Thanks, @speth! I believe it's all addressed. I replaced some old group labels with a more standardized |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, @ischoegl, this looks good to me.
Changes proposed in this pull request
Restructure/consolidate/correct/update doxygen documentation for the following:
The main objective is to generate an adequate browsable structure for the Modules tab; the underlying docstrings are largely unchanged.
In addition, the mainfile is switched to Markdown (supported since doxygen 1.8.3 - released in 2012).
Partially addresses #1535
Closes #1516
Checklist
scons build
&scons test
) and unit tests address code coverage