coffee/continuable
1
0
Fork 0
mirror of https://github.com/Naios/continuable.git synced 2025-12-06 16:56:44 +08:00
Code Issues Packages Projects Releases Wiki Activity

Some doxygen additions and improvements

Browse Source
This commit is contained in:
Denis Blank 2018-01-30 21:37:30 +01:00
parent 1daa13b1d6
commit 4b317fb964
3 changed files with 17 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
doc/Index.md
View File

@ -1,13 +1,11 @@
![](https://raw.githubusercontent.com/Naios/continuable/master/doc/slideshow.gif) ![](https://raw.githubusercontent.com/Naios/continuable/master/doc/slideshow.gif)
This documentation covers the continuable library in detail
## Content ## Content
- **Class cti::continuable_base** - main class for continuation chaining. - **Class cti::continuable_base** - for building up a continuation chain.
- \link cti::continuable_base::then then\endlink - adds a callback or cti::continuable_base to the invocation chain. - \link cti::continuable_base::then then\endlink - adds a callback or cti::continuable_base to the invocation chain.
- \link cti::continuable_base::fail fail\endlink - adds an error callback to the invocation chain. - \link cti::continuable_base::fail fail\endlink - adds an error callback to the invocation chain.
- \link cti::continuable_base::flow flow\endlink - adds an error and result callback to the invocation chain. - \link cti::continuable_base::next next\endlink - adds an error and result callback to the invocation chain.
- \link cti::continuable_base::operator | operator|\endlink - connects another object through \link cti::continuable_base::then then\endlink. - \link cti::continuable_base::operator | operator|\endlink - connects another object through \link cti::continuable_base::then then\endlink.
- \link cti::continuable_base::operator && operator&&\endlink - connects another cti::continuable_base with an *all* logic. - \link cti::continuable_base::operator && operator&&\endlink - connects another cti::continuable_base with an *all* logic.
- \link cti::continuable_base::operator|| operator||\endlink - connects another cti::continuable_base with an *any* logic. - \link cti::continuable_base::operator|| operator||\endlink - connects another cti::continuable_base with an *any* logic.
@ -15,15 +13,18 @@ This documentation covers the continuable library in detail
- \link cti::continuable_base::done done\endlink - \copybrief cti::continuable_base::done - \link cti::continuable_base::done done\endlink - \copybrief cti::continuable_base::done
- \link cti::continuable_base::freeze freeze \endlink - prevents the automatic invocation on destruction of the cti::continuable_base. - \link cti::continuable_base::freeze freeze \endlink - prevents the automatic invocation on destruction of the cti::continuable_base.
- \link cti::continuable_base::is_frozen is_frozen\endlink - \copybrief cti::continuable_base::is_frozen - \link cti::continuable_base::is_frozen is_frozen\endlink - \copybrief cti::continuable_base::is_frozen
- **Class cti::promise_base** - for resolving a continuation chain through a result or error.
- \link cti::promise_base::set_value set_value\endlink - resolves the continuation chain through a result.
- \link cti::promise_base::set_exception set_exception\endlink - resolves the continuation chain through an error.
- **Helper functions** - **Helper functions**
- \link cti::make_continuable make_continuable\endlink - creates a cti::continuable_base from a callback tanking function. - \link cti::make_continuable make_continuable\endlink - creates a cti::continuable_base from a callback tanking function.
- \link cti::when_all when_all\endlink - connects all given cti::continuable_base objects with an *all* logic. - \link cti::when_all when_all\endlink - connects all given cti::continuable_base objects with an *all* logic.
- \link cti::when_any when_any\endlink - connects all given cti::continuable_base objects with an *any* logic. - \link cti::when_any when_any\endlink - connects all given cti::continuable_base objects with an *any* logic.
- \link cti::when_seq when_seq\endlink - connects all given cti::continuable_base objects with a *sequence* logic. - \link cti::when_seq when_seq\endlink - connects all given cti::continuable_base objects with a *sequence* logic.
- **Transforms** - Apply a transform to the continuable - **Transforms** - Apply a transform to the continuable
- \link cti::futurize futurize\endlink - \copybrief cti::futurize - \link cti::transforms::futurize futurize\endlink - \copybrief cti::transforms::futurize
- \link cti::flatten flatten\endlink - \copybrief cti::flatten - \link cti::transforms::flatten flatten\endlink - \copybrief cti::transforms::flatten
- **Predefined erasures** - Predefined type erarasures for continuables and promises - **Predefined (erased) types** - Predefined type erarasures for continuables and promises
- \link cti::promise promise\endlink - \copybrief cti::promise - \link cti::promise promise\endlink - \copybrief cti::promise
- \link cti::continuable continuable\endlink - \copybrief cti::continuable - \link cti::continuable continuable\endlink - \copybrief cti::continuable
- \link cti::unique_continuable unique_continuable\endlink - \copybrief cti::unique_continuable - \link cti::unique_continuable unique_continuable\endlink - \copybrief cti::unique_continuable

11
include/continuable/continuable-promise-base.hpp
View File

@ -43,15 +43,20 @@ namespace cti {
/// The promise_base makes it possible to resolve an asynchronous /// The promise_base makes it possible to resolve an asynchronous
/// continuable through it's result or through an error type. /// continuable through it's result or through an error type.
/// ///
/// Use the promise type defined in `continuable/continuable.hpp`, /// Use the promise type defined in `continuable/continuable_types.hpp`,
/// in order to use this class. /// in order to use this class.
/// ///
/// \since version 2.0.0 /// \since version 2.0.0
// clang-format off
template <typename Data, typename Hint> template <typename Data, typename Hint>
class promise_base; class promise_base
/// \cond false
;
template <typename Data, typename... Args> template <typename Data, typename... Args>
class promise_base<Data, detail::hints::signature_hint_tag<Args...>> class promise_base<Data, detail::hints::signature_hint_tag<Args...>>
: detail::util::non_copyable { : detail::util::non_copyable
/// \endcond
{ // clang-format on
/// \cond false /// \cond false
// The callback type // The callback type

2
include/continuable/continuable-transforms.hpp
View File

@ -39,7 +39,7 @@ namespace cti {
/// any continuable_base to an object or to a continuable_base itself. /// any continuable_base to an object or to a continuable_base itself.
/// ///
/// Transforms can be applied to continuables through using /// Transforms can be applied to continuables through using
/// the continuable-base::apply method accordingly. /// the cti::continuable_base::apply method accordingly.
namespace transforms { namespace transforms {
/// Returns a transform that if applied to a continuable, /// Returns a transform that if applied to a continuable,
/// it will start the continuation chain and returns the asynchronous /// it will start the continuation chain and returns the asynchronous