Skip to content

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

Open
FIERsity wants to merge 2 commits into
bemanproject:mainfrom
FIERsity:codex/doxygen-scope-api-docs
Open

FIERsity wants to merge 2 commits 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

@JeffGarland

Copy link
Copy Markdown
Member

Sorry for the delayed review @FIERsity -- thank you for your contribution!

Comment thread include/beman/scope/scope.hpp Outdated

@JeffGarland JeffGarland left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

one suggestion -- otherwise LGTM

@JeffGarland
JeffGarland marked this pull request as ready for review September 18, 2026 14:33
@coveralls

Copy link
Copy Markdown

Coverage Status

coverage: 100.0%. remained the same — FIERsity:codex/doxygen-scope-api-docs into bemanproject:main

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

3 participants