Skip to content

Update doxygen Chemical Kinetics/Numerics Documentation#1534

Merged
speth merged 8 commits intoCantera:mainfrom
ischoegl:update-doxygen
Jul 16, 2023
Merged

Update doxygen Chemical Kinetics/Numerics Documentation#1534
speth merged 8 commits intoCantera:mainfrom
ischoegl:update-doxygen

Conversation

@ischoegl
Copy link
Copy Markdown
Member

@ischoegl ischoegl commented Jul 7, 2023 •
edited
Loading

Changes proposed in this pull request

Restructure/consolidate/correct/update doxygen documentation for the following:

  • Chemical Kinetics objects
  • Numerical utilities
  • Global Data
  • Exception Handling

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

  • 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 requested a review from a team July 7, 2023 18:05
@ischoegl ischoegl mentioned this pull request Jul 7, 2023
Closed
3 tasks
@ischoegl ischoegl changed the title Update doxygen Chemical Kinetics Documentation Update doxygen Chemical Kinetics/Numerics Documentation Jul 7, 2023
@codecov
Copy link
Copy Markdown

codecov bot commented Jul 7, 2023 •
edited
Loading

Codecov Report

Merging #1534 (3b64999) into main (f89efe8) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           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
Impacted Files Coverage Δ
include/cantera/base/Array.h 82.75% <ø> (ø)
include/cantera/base/ExternalLogger.h 39.13% <ø> (ø)
include/cantera/base/NoExitLogger.h 0.00% <ø> (ø)
include/cantera/base/Solution.h 87.50% <ø> (ø)
include/cantera/base/ctexceptions.h 60.86% <ø> (ø)
include/cantera/base/global.h 81.81% <ø> (ø)
include/cantera/base/logger.h 78.57% <ø> (ø)
include/cantera/base/utilities.h 96.66% <ø> (ø)
include/cantera/equil/ChemEquil.h 100.00% <ø> (ø)
include/cantera/equil/MultiPhase.h 100.00% <ø> (ø)
... and 34 more

... and 3 files with indirect coverage changes

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

@ischoegl ischoegl marked this pull request as draft July 7, 2023 20:17
@ischoegl ischoegl force-pushed the update-doxygen branch 3 times, most recently from ea25789 to ee55684 Compare July 7, 2023 23:45
@ischoegl ischoegl marked this pull request as ready for review July 7, 2023 23:48
@ischoegl ischoegl force-pushed the update-doxygen branch 3 times, most recently from 1bd2361 to 2c7b471 Compare July 8, 2023 01:06
@ischoegl
Copy link
Copy Markdown
Member Author

ischoegl commented Jul 8, 2023

@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.

@ischoegl ischoegl removed the Kinetics label Jul 8, 2023
@ischoegl ischoegl force-pushed the update-doxygen branch 4 times, most recently from 040bad6 to 59ee816 Compare July 11, 2023 13:15
@ischoegl ischoegl mentioned this pull request Jul 14, 2023
Closed
speth
speth requested changes Jul 15, 2023
View reviewed changes
Copy link
Copy Markdown
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.

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.

@ischoegl
Copy link
Copy Markdown
Member Author

ischoegl commented Jul 15, 2023 •
edited
Loading

Thanks, @speth! I believe it's all addressed. I replaced some old group labels with a more standardized xyzGroup (only where you had comments).

speth
speth approved these changes Jul 16, 2023
View reviewed changes
Copy link
Copy Markdown
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.

Thanks, @ischoegl, this looks good to me.

@speth speth merged commit 25e8e5c into Cantera:main Jul 16, 2023
@ischoegl ischoegl deleted the update-doxygen branch July 17, 2023 02:46
@ischoegl ischoegl mentioned this pull request Jul 22, 2023
Closed
10 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@speth speth speth approved these changes

Assignees

No one assigned

Labels

documentation

Projects

No open projects
Cantera 3.0 Release Planning
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Improve main page of C++ documentation

2 participants

@ischoegl @speth