mirror of
https://github.com/Naios/continuable.git
synced 2025-12-06 16:56:44 +08:00
In source documentation improvements
This commit is contained in:
parent
27aafa2f0e
commit
4c39532d7c
@ -37,6 +37,6 @@ The [documentation](https://naios.github.io/continuable/) offers everything you
|
|||||||
|
|
||||||
#### Issues and contributions
|
#### Issues and contributions
|
||||||
|
|
||||||
Issues reports are accepted through the Github issue tracker as well as Pull requests.
|
Issue reports are accepted through the Github issue tracker as well as Pull requests.
|
||||||
Every contribution is welcome! Don't hesitate to ask for help if you need any support
|
Every contribution is welcome! Don't hesitate to ask for help if you need any support
|
||||||
in changing the implementation or when using the library.
|
in improving the implementation or if you have any troubles in using the library.
|
||||||
|
|||||||
@ -89,7 +89,8 @@ using error_type = detail::types::error_type;
|
|||||||
/// Deduces to a true_type if the given type is a continuable_base.
|
/// Deduces to a true_type if the given type is a continuable_base.
|
||||||
///
|
///
|
||||||
/// \since 3.0.0
|
/// \since 3.0.0
|
||||||
using detail::base::is_continuable;
|
template <typename T>
|
||||||
|
using is_continuable = detail::base::is_continuable<T>;
|
||||||
|
|
||||||
/// The main class of the continuable library, it provides the functionality
|
/// The main class of the continuable library, it provides the functionality
|
||||||
/// for chaining callbacks and continuations together to a unified hierarchy.
|
/// for chaining callbacks and continuations together to a unified hierarchy.
|
||||||
@ -791,7 +792,7 @@ private:
|
|||||||
///
|
///
|
||||||
/// \since 1.0.0
|
/// \since 1.0.0
|
||||||
template <typename... Args, typename Continuation>
|
template <typename... Args, typename Continuation>
|
||||||
auto make_continuable(Continuation&& continuation) {
|
constexpr auto make_continuable(Continuation&& continuation) {
|
||||||
static_assert(sizeof...(Args) > 0,
|
static_assert(sizeof...(Args) > 0,
|
||||||
"Since version 3.0.0 make_continuable requires an exact "
|
"Since version 3.0.0 make_continuable requires an exact "
|
||||||
"signature! If you did intend to create a void continuable "
|
"signature! If you did intend to create a void continuable "
|
||||||
@ -804,7 +805,7 @@ auto make_continuable(Continuation&& continuation) {
|
|||||||
detail::util::ownership{});
|
detail::util::ownership{});
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Returns a continuable with no result which instantly resolves
|
/// Returns a continuable_base with no result which instantly resolves
|
||||||
/// the promise with no values.
|
/// the promise with no values.
|
||||||
///
|
///
|
||||||
/// \attention Usually using this function isn't needed at all since
|
/// \attention Usually using this function isn't needed at all since
|
||||||
@ -821,7 +822,7 @@ constexpr auto make_ready_continuable() {
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Returns a continuable with one result value which instantly resolves
|
/// Returns a continuable_base with one result value which instantly resolves
|
||||||
/// the promise with the given value.
|
/// the promise with the given value.
|
||||||
///
|
///
|
||||||
/// \copydetails make_ready_continuable()
|
/// \copydetails make_ready_continuable()
|
||||||
@ -833,8 +834,8 @@ constexpr auto make_ready_continuable(Result&& result) {
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Returns a continuable with multiple result values which instantly resolves
|
/// Returns a continuable_base with multiple result values which instantly
|
||||||
/// the promise with the given values.
|
/// resolves the promise with the given values.
|
||||||
///
|
///
|
||||||
/// \copydetails make_ready_continuable()
|
/// \copydetails make_ready_continuable()
|
||||||
template <typename FirstResult, typename SecondResult, typename... Rest>
|
template <typename FirstResult, typename SecondResult, typename... Rest>
|
||||||
@ -852,7 +853,7 @@ constexpr auto make_ready_continuable(FirstResult&& first_result,
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Returns a continuable with the parameterized result which instantly
|
/// Returns a continuable_base with the parameterized result which instantly
|
||||||
/// resolves the promise with the given error type.
|
/// resolves the promise with the given error type.
|
||||||
///
|
///
|
||||||
/// See an example below:
|
/// See an example below:
|
||||||
|
|||||||
@ -36,14 +36,17 @@
|
|||||||
|
|
||||||
namespace cti {
|
namespace cti {
|
||||||
/// \defgroup Transforms Transforms
|
/// \defgroup Transforms Transforms
|
||||||
/// provides utilities to convert \link continuable_base continuable_bases\endlink to other types (`std::future`).
|
/// provides utilities to convert
|
||||||
|
/// \link continuable_base continuable_bases\endlink to other
|
||||||
|
/// types such as (`std::future`).
|
||||||
/// \{
|
/// \{
|
||||||
|
|
||||||
/// A callable tag object which marks a wrapped callable object
|
/// A callable tag object which marks a wrapped callable object
|
||||||
/// as continuable transformation which enables some useful overloads.
|
/// as continuable transformation which enables some useful overloads.
|
||||||
///
|
///
|
||||||
/// \since 3.0.0
|
/// \since 3.0.0
|
||||||
using detail::types::transform;
|
template <typename T>
|
||||||
|
using transform = detail::types::transform<T>;
|
||||||
|
|
||||||
/// Wraps the given callable object into a transform class.
|
/// Wraps the given callable object into a transform class.
|
||||||
///
|
///
|
||||||
|
|||||||
@ -41,26 +41,29 @@ namespace cti {
|
|||||||
/// \{
|
/// \{
|
||||||
|
|
||||||
/// A tag which is passed to the `operator()` of the visitor
|
/// A tag which is passed to the `operator()` of the visitor
|
||||||
/// if an element is visited synchronously.
|
/// if an element is visited synchronously through \ref traverse_pack_async.
|
||||||
///
|
///
|
||||||
/// \since 3.0.0
|
/// \since 3.0.0
|
||||||
using detail::traversal::async_traverse_visit_tag;
|
using async_traverse_visit_tag = detail::traversal::async_traverse_visit_tag;
|
||||||
/// A tag which is passed to the `operator()` of the visitor
|
/// A tag which is passed to the `operator()` of the visitor if an element is
|
||||||
/// if an element is visited after the traversal was detached.
|
/// visited after the traversal was detached through \ref traverse_pack_async.
|
||||||
///
|
///
|
||||||
/// \since 3.0.0
|
/// \since 3.0.0
|
||||||
using detail::traversal::async_traverse_detach_tag;
|
using async_traverse_detach_tag = detail::traversal::async_traverse_detach_tag;
|
||||||
/// A tag which is passed to the `operator()` of the visitor
|
/// A tag which is passed to the `operator()` of the visitor if the
|
||||||
/// if the asynchronous pack traversal was finished.
|
/// asynchronous pack traversal was finished through \ref traverse_pack_async.
|
||||||
///
|
///
|
||||||
/// \since 3.0.0
|
/// \since 3.0.0
|
||||||
using detail::traversal::async_traverse_complete_tag;
|
using async_traverse_complete_tag =
|
||||||
|
detail::traversal::async_traverse_complete_tag;
|
||||||
|
|
||||||
/// A tag to identify that a mapper shall be constructed in-place
|
/// A tag to identify that a mapper shall be constructed in-place
|
||||||
/// from the first argument passed.
|
/// from the first argument passed to \ref traverse_pack_async.
|
||||||
///
|
///
|
||||||
/// \since 3.0.0
|
/// \since 3.0.0
|
||||||
using detail::traversal::async_traverse_in_place_tag;
|
template <typename T>
|
||||||
|
using async_traverse_in_place_tag =
|
||||||
|
detail::traversal::async_traverse_in_place_tag<T>;
|
||||||
|
|
||||||
/// Traverses the pack with the given visitor in an asynchronous way.
|
/// Traverses the pack with the given visitor in an asynchronous way.
|
||||||
///
|
///
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user