Skip to content

[codex] make scope.hpp API comments Doxygen-ready - #67

Draft
FIERsity wants to merge 1 commit into
bemanproject:mainfrom
FIERsity:codex/doxygen-scope-api-docs
Draft

[codex] make scope.hpp API comments Doxygen-ready#67
FIERsity wants to merge 1 commit into
bemanproject:mainfrom
FIERsity:codex/doxygen-scope-api-docs

Conversation

@FIERsity

Copy link
Copy Markdown

Summary

Improve the API documentation in scope.hpp so the public declarations can be consumed more effectively by Doxygen.

The added documentation covers:

  • scope_exit, scope_fail, and scope_success;
  • unique_resource and make_unique_resource_checked;
  • scope-guard concepts and construction behavior;
  • scope_guard constructors, destruction, release, and deduction guides;
  • the invocation-checker types used by the public aliases.

This change only updates comments and does not alter runtime behavior.

Validation

  • compiled the header with GCC 16 in C++20 mode;
  • syntax-checked all non-module examples:
    • scope_example.cpp
    • unique_resource.cpp
    • unique_resource_file.cpp
  • git diff --check

Doxygen, 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

cleanup code docs making them all doxygen capable

1 participant