Conversation
Codecov Report
@@ Coverage Diff @@
## main #1543 +/- ##
==========================================
- Coverage 70.47% 70.46% -0.02%
==========================================
Files 376 379 +3
Lines 59081 59080 -1
Branches 21222 21222
==========================================
- Hits 41640 41633 -7
- Misses 14360 14367 +7
+ Partials 3081 3080 -1
... and 14 files with indirect coverage changes 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
ischoegl
force-pushed
the
update-doxygen2
branch
from
f4195f6 to
da574fd
Compare
| //! Return a reference to the Jacobian evaluator of an OneDim object. | ||
| //! @ingroup derivGroup |
There was a problem hiding this comment.
I see what you're trying to do by adding the class name to the docstring, but the way member functions are shown in Doxygen's "modules" leaves a fair bit to be desired, as I'm sure you've noticed. While I think the two groups touched on in this PR are okay, I'd suggest not going any further in the direction of trying to populate such groups, if you hadn't already come to that conclusion.
There was a problem hiding this comment.
I tried to collect some spots where Jacobians are evaluated, as they are relevant to the new derivGroup module. I indeed tried to mitigate the lacking presentation. I have no intention to make this more wide-spread.
There is some need to document PreconditionerBase etc, which hopefully will take care of some of these stop-gap entries.
There was a problem hiding this comment.
breathe may eventually provide us with an opportunity to adjust the presentation, so I think this is fine for now.
ischoegl
force-pushed
the
update-doxygen2
branch
from
eac26ab to
4354877
Compare
|
@speth ... I believe I addressed everything. |
2 participants
Changes proposed in this pull request
oneDdocumentationzeroDdocumentationIf applicable, fill in the issue number this pull request is fixing
Resolves #1535
If applicable, provide an example illustrating new features this pull request is introducing
Checklist
scons build&scons test) and unit tests address code coverage