Add doxygen comments to DiagsTypes.hh#13262
Open
JosiahWI wants to merge 13 commits into
Open
Conversation
JosiahWI
changed the title
JosiahWI
commented
Jun 12, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds Doxygen (“oxygen”) comments to ATS’s diagnostics and regression-test interfaces to make the Diags subsystem’s behavior easier to understand and navigate from headers.
Changes:
- Adds API-level documentation for
tell_diags_regression_testing_is_on()inRegression.h. - Adds extensive Doxygen comments across
DiagsTypes.hfor Diags configuration, tag activation, output routing, and log rolling/redirection APIs. - Adds documentation for the global
Diagssingleton registration/access inDiags.h.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 13 comments.
| File | Description |
|---|---|
| include/tscore/Regression.h | Documents regression-mode diags behavior. |
| include/tscore/DiagsTypes.h | Adds Doxygen comments for Diags types, fields, and public APIs. |
| include/tscore/Diags.h | Documents DiagsPtr::set() and diags() singleton accessor. |
JosiahWI
changed the title
bneradt
requested changes
Jun 15, 2026
Comment on lines
+356
to
+357
| /** | ||
| * @brief Test whether emission for the given tag mode is globally enabled. |
Contributor
There was a problem hiding this comment.
Alan told me, back in the day, not to do @brief because Sphinx was configured for brief after the /**. Thus this instead:
/** Test whether...This applies to the other @brief uses in this file as well.
Contributor
Author
There was a problem hiding this comment.
Thanks for sharing this knowledge. I'll update my Claude skill to enforce this.
This file contains hidden or 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
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.
I am testing out Claude Sonnet 4.6 and Claude Opus 4.7 with spec-kit. This change was generated by those models. Since code comments are very tedious to write by hand (especially for pre-existing code) and can provide great benefit, I think this is a good use case for experimentation. If this is accepted, I might do more of these as I refine my spec-kit configuration.