coffee/continuable
1
0
Fork 0
mirror of https://github.com/Naios/continuable.git synced 2026-02-08 18:56:40 +08:00
Code Issues Packages Projects Releases Wiki Activity

Convert some \note into \attention tags

Browse Source
This commit is contained in:
Denis Blank 2017-03-03 14:12:54 +01:00
parent fae3d42ee0
commit 54de52cb4b
1 changed files with 14 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
include/continuable/continuable-base.hpp
View File

@ -77,6 +77,11 @@ inline namespace abi_v1 {
/// of a method call. You may copy a continuable which underlying /// of a method call. You may copy a continuable which underlying
/// storages are copyable to split the call hierarchy into multiple parts. /// storages are copyable to split the call hierarchy into multiple parts.
/// ///
/// \attention The continuable_base objects aren't intended to be stored.
/// If you want to store a continuble_base you should always
/// call the continuable_base::freeze method for disabling the
/// invocation on destruction.
///
/// \since version 1.0.0 /// \since version 1.0.0
template <typename Data, typename Annotation> class continuable_base; template <typename Data, typename Annotation> class continuable_base;
@ -1768,14 +1773,14 @@ public:
return detail::transforms::as_future(std::move(*this).materialize()); return detail::transforms::as_future(std::move(*this).materialize());
} }
/// Invokes the continuation chain before the continuable_base /// Invokes the continuation chain manually even before the continuable_base
/// is destructed. This will release the object. /// is destructed. This will release the object.
/// ///
/// \see continuable_base::~continuable_base() for further details about /// \see continuable_base::~continuable_base() for further details about
/// the continuation invocation on destruction. /// the continuation invocation on destruction.
/// ///
/// \note This method will trigger an assertion if the /// \attention This method will trigger an assertion if the
/// continuable_base was released already. /// continuable_base was released already.
/// ///
/// \since version 1.0.0 /// \since version 1.0.0
void done() && { detail::base::finalize_continuation(std::move(*this)); } void done() && { detail::base::finalize_continuation(std::move(*this)); }
@ -1786,8 +1791,8 @@ public:
/// ///
/// \see continuable_base::freeze for further details. /// \see continuable_base::freeze for further details.
/// ///
/// \note This method will trigger an assertion if the /// \attention This method will trigger an assertion if the
/// continuable_base was released already. /// continuable_base was released already.
/// ///
/// \since version 1.0.0 /// \since version 1.0.0
bool is_frozen() const noexcept { bool is_frozen() const noexcept {
@ -1796,8 +1801,8 @@ public:
} }
/// Prevents the automatic invocation of the continuation chain /// Prevents the automatic invocation of the continuation chain
/// on destruction of the continuable_base. You may still invoke the chain /// which happens on destruction of the continuable_base.
/// through the continuable_base::done method. /// You may still invoke the chain through the continuable_base::done method.
/// ///
/// This is useful for storing a continuable_base inside a continuation /// This is useful for storing a continuable_base inside a continuation
/// chain while storing it for further usage. /// chain while storing it for further usage.
@ -1807,8 +1812,8 @@ public:
/// \see continuable_base::~continuable_base() for further details about /// \see continuable_base::~continuable_base() for further details about
/// the continuation invocation on destruction. /// the continuation invocation on destruction.
/// ///
/// \note This method will trigger an assertion if the /// \attention This method will trigger an assertion if the
/// continuable_base was released already. /// continuable_base was released already.
/// ///
/// \since version 1.0.0 /// \since version 1.0.0
continuable_base& freeze(bool enabled = true) & noexcept { continuable_base& freeze(bool enabled = true) & noexcept {