[codex] make scope.hpp API comments Doxygen-ready - #67
Draft
FIERsity wants to merge 1 commit into
Draft
Conversation
Member
|
Sorry for the delayed review @FIERsity -- thank you for your contribution! |
JeffGarland
reviewed
Sep 6, 2026
| * @tparam InvokeChecker callable function that handles checking if callback should be called on scope exit. | ||
| * @tparam ConstructionExceptionBehavior callable function that defines the behavior if an exception occurs | ||
| * on the construction. | ||
| /** |
Member
There was a problem hiding this comment.
Suggested change
| /** | |
| /** Generalized scope guard template |
We still want an overall description
JeffGarland
requested changes
Sep 6, 2026
JeffGarland
left a comment
Member
There was a problem hiding this comment.
one suggestion -- otherwise LGTM
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
2 participants
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.
Summary
Improve the API documentation in
scope.hppso the public declarations can be consumed more effectively by Doxygen.The added documentation covers:
scope_exit,scope_fail, andscope_success;unique_resourceandmake_unique_resource_checked;scope_guardconstructors, destruction, release, and deduction guides;This change only updates comments and does not alter runtime behavior.
Validation
scope_example.cppunique_resource.cppunique_resource_file.cppgit diff --checkDoxygen, CMake, and pre-commit were not available in the local environment, so generated documentation and the full project workflow were not run locally.
Fixes #38