Improve optimistic lock Doxygen docs #685
Conversation
- Add optimistic-lock Doxygen topic - Move optimistic_lock.hpp file-level docs to this topic - Add docs for in_fake_critical_section.hpp, link from optimistic_lock.hpp as needed - Cleanup its declarations a little bit
WalkthroughThis pull request updates header and documentation files to improve clarity and consistency across fake and optimistic locking primitives. Key changes include enhanced comments, revised class definitions with added operator overloads and deletion of copy/move operations, new destructors, and clearer method documentation. Additionally, a new documentation group for optimistic locking has been introduced and the assignment operator signature in one file has been simplified. These modifications do not alter the primitives’ no-op behavior but refine their interfaces and documentation. Changes
Possibly related PRs
Poem
✨ Finishing Touches
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (3)
in_fake_critical_section.hpp(2 hunks)modules.dox(1 hunks)optimistic_lock.hpp(7 hunks)
🔇 Additional comments (5)
in_fake_critical_section.hpp (2)
33-75: LGTM! Well-documented no-op implementation.The class provides a clear no-op implementation with:
- Appropriate method attributes (
[[nodiscard]],noexcept)- Proper deletion of copy/move operations
- Clear documentation for each method
88-156: LGTM! Well-structured wrapper implementation.The template class provides a clear implementation with:
- Comprehensive documentation
- Appropriate method attributes
- Proper deletion of copy/move operations
optimistic_lock.hpp (2)
8-11: LGTM! Documentation improvements enhance clarity.The documentation changes effectively:
- Add proper grouping for optimistic locking
- Link to no-op counterparts for single-threaded contexts
Also applies to: 283-288, 450-453, 872-875
893-897: LGTM! Simplified operator signature.The assignment operator signature has been simplified by removing the redundant template parameter from the type.
modules.dox (1)
6-9: LGTM! Well-structured documentation group.The new optimistic locking group is:
- Properly defined and described
- Correctly linked to the internals group
|
Summary by CodeRabbit