Enhance documentation and structure across multiple headers#43
Merged
Conversation
- Updated `chaos.hpp` to improve descriptions and clarify usage of `ChaosConfig` and `ChaosController`. - Enhanced `concepts.hpp` with detailed explanations for C++20 concepts and their fallbacks for older compilers. - Improved `error_handler.hpp` to provide clearer descriptions of error handling mechanisms and callback functionalities. - Expanded `expected.hpp` with comprehensive documentation for the polyfill of `std::expected`, including exception handling and monadic operations. - Refined `generator.hpp` to clarify the coroutine's behavior and usage examples. - Enhanced `profiles.hpp` with detailed descriptions of thread profiles and their application. - Updated `pthread_wrapper.hpp` to provide clearer semantics for POSIX thread wrappers and attributes. - Improved `scheduled_pool.hpp` to clarify task scheduling features and cancellation semantics. - Enhanced `scheduler_policy.hpp` with detailed explanations of scheduling policies and thread priority management. - Updated `task.hpp` to provide comprehensive documentation for coroutine tasks and their awaiters.
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
1 participant
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.
chaos.hppto improve descriptions and clarify usage ofChaosConfigandChaosController.concepts.hppwith detailed explanations for C++20 concepts and their fallbacks for older compilers.error_handler.hppto provide clearer descriptions of error handling mechanisms and callback functionalities.expected.hppwith comprehensive documentation for the polyfill ofstd::expected, including exception handling and monadic operations.generator.hppto clarify the coroutine's behavior and usage examples.profiles.hppwith detailed descriptions of thread profiles and their application.pthread_wrapper.hppto provide clearer semantics for POSIX thread wrappers and attributes.scheduled_pool.hppto clarify task scheduling features and cancellation semantics.scheduler_policy.hppwith detailed explanations of scheduling policies and thread priority management.task.hppto provide comprehensive documentation for coroutine tasks and their awaiters.