diff --git a/doc/Doxyfile b/doc/Doxyfile index f39241b..259e979 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -32,7 +32,7 @@ DOXYFILE_ENCODING = UTF-8 # title of most generated pages and in a few other places. # The default value is: My Project. -PROJECT_NAME = continuable +PROJECT_NAME = Continuable # The PROJECT_NUMBER tag can be used to enter a project or revision number. This # could be handy for archiving the generated documentation or if some version diff --git a/doc/Index.md b/doc/Index.md index f3b7b18..95ebd5b 100644 --- a/doc/Index.md +++ b/doc/Index.md @@ -1,20 +1,35 @@ -# Documentation of continuable +![](https://raw.githubusercontent.com/Naios/continuable/master/doc/slideshow.gif) This documentation covers the continuable library in detail ## Content -- Class cti::continuable_base - main class for continuation chaining. +- **Class cti::continuable_base** - main class for continuation chaining. - \link cti::continuable_base::then then\endlink - adds a callback or cti::continuable_base to the invocation chain. - - \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::release release\endlink - releases the cti::continuable_base and prevents the automatic invocation on destruction. -- Helper functions + - \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 a *sequential* logic. + - \link cti::continuable_base::futurize futurize\endlink - \copybrief cti::continuable_base::futurize + - \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::is_frozen is_frozen\endlink - \copybrief cti::continuable_base::is_frozen + +- **Helper functions** - \link cti::make_continuable make_continuable\endlink - creates a cti::continuable_base from a callback tanking function. - \link cti::all_of all_of\endlink - connects all given cti::continuable_base objects with an *all* logic. - \link cti::any_of any_of\endlink - connects all given cti::continuable_base objects with an *any* logic. -- GTest macros: - - \link EXPECT_ASYNC_RESULT EXPECT_ASYNC_RESULT\endlink - Expects that the given continuable is finished with the given result. - - \link ASSERT_ASYNC_RESULT ASSERT_ASYNC_RESULT\endlink - Asserts that the given continuable is finished with the given result. - - \link ASSERT_ASYNC_TYPES ASSERT_ASYNC_TYPES\endlink - Asserts that the given continuable is finished with the given types without validating it against equality. + - \link cti::seq_of seq_of\endlink - connects all given cti::continuable_base objects with a *sequence* logic. +- **Class cti::continuable_trait** - A trait class for defining your own cti::continuable_base trait with the type-erasure backend of your choice. + - \link cti::continuable_trait::callback callback\endlink - \copybrief cti::continuable_trait::callback + - \link cti::continuable_trait::continuation continuation\endlink - \copybrief cti::continuable_trait::continuation + - \link cti::continuable_trait::continuable continuable\endlink - \copybrief cti::continuable_trait::continuable + +- **GTest macros:** + - \link ASSERT_ASYNC_COMPLETION ASSERT_ASYNC_COMPLETION \endlink - \copybrief ASSERT_ASYNC_COMPLETION + - \link ASSERT_ASYNC_NEVER_COMPLETED ASSERT_ASYNC_NEVER_COMPLETED \endlink - \copybrief ASSERT_ASYNC_NEVER_COMPLETED + - \link ASSERT_ASYNC_VALIDATION ASSERT_ASYNC_VALIDATION \endlink - \copybrief ASSERT_ASYNC_VALIDATION + - \link ASSERT_ASYNC_BINARY_VALIDATION ASSERT_ASYNC_BINARY_VALIDATION \endlink - \copybrief ASSERT_ASYNC_BINARY_VALIDATION + - \link EXPECT_ASYNC_RESULT EXPECT_ASYNC_RESULT \endlink - \copybrief EXPECT_ASYNC_RESULT + - \link ASSERT_ASYNC_RESULT ASSERT_ASYNC_RESULT \endlink - \copybrief ASSERT_ASYNC_RESULT + - \link ASSERT_ASYNC_TYPES ASSERT_ASYNC_TYPES \endlink - \copybrief ASSERT_ASYNC_TYPES diff --git a/include/continuable/continuable-base.hpp b/include/continuable/continuable-base.hpp index e7e374a..662d504 100644 --- a/include/continuable/continuable-base.hpp +++ b/include/continuable/continuable-base.hpp @@ -1773,8 +1773,8 @@ public: return detail::transforms::as_future(std::move(*this).materialize()); } - /// Invokes the continuation chain manually even before the continuable_base - /// is destructed. This will release the object. + /// Invokes the continuation chain manually even before the + /// cti::continuable_base is destructed. This will release the object. /// /// \see continuable_base::~continuable_base() for further details about /// the continuation invocation on destruction. @@ -1785,7 +1785,7 @@ public: /// \since version 1.0.0 void done() && { detail::base::finalize_continuation(std::move(*this)); } - /// Predicate to check whether the continuable_base is frozen or not. + /// Predicate to check whether the cti::continuable_base is frozen or not. /// /// \returns Returns true when the continuable_base is frozen. ///