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

Improve the documentation

Browse Source
This commit is contained in:
Denis Blank 2017-10-04 19:07:20 +02:00
parent 2b061a6058
commit f3c33b58c6
36 changed files with 2515 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.gitignore vendored
View File

@ -47,6 +47,3 @@ bld/
# Visual Studo 2015 cache/options directory # Visual Studo 2015 cache/options directory
.vs/ .vs/
doc/doxygen/

2
doc/code/documentation/doc-documentation.cpp
View File

@ -1,4 +1,4 @@
/** /*
Copyright(c) 2015 - 2017 Denis Blank <denis.blank at outlook dot com> Copyright(c) 2015 - 2017 Denis Blank <denis.blank at outlook dot com>
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy

2
doc/code/slideshow/doc-slideshow.cpp
View File

@ -1,4 +1,4 @@
/** /*
Copyright(c) 2015 - 2017 Denis Blank <denis.blank at outlook dot com> Copyright(c) 2015 - 2017 Denis Blank <denis.blank at outlook dot com>
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy

1
doc/doxygen/.gitignore vendored Normal file
View File

@ -0,0 +1 @@
doxygen/

2458
doc/doxygen/Doxyfile Normal file
View File

File diff suppressed because it is too large Load Diff

4
include/continuable/detail/api.hpp → include/continuable/continuable-api.hpp
View File

@ -1,5 +1,5 @@
/** /*
/~` _ _ _|_. _ _ |_ | _ /~` _ _ _|_. _ _ |_ | _
\_,(_)| | | || ||_|(_||_)|(/_ \_,(_)| | | || ||_|(_||_)|(/_
@ -26,7 +26,7 @@
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE. SOFTWARE.
**/ */
#ifndef CONTINUABLE_DETAIL_API_HPP_INCLUDED__ #ifndef CONTINUABLE_DETAIL_API_HPP_INCLUDED__
#define CONTINUABLE_DETAIL_API_HPP_INCLUDED__ #define CONTINUABLE_DETAIL_API_HPP_INCLUDED__

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

@ -1,5 +1,5 @@
/** /*
/~` _ _ _|_. _ _ |_ | _ /~` _ _ _|_. _ _ |_ | _
\_,(_)| | | || ||_|(_||_)|(/_ \_,(_)| | | || ||_|(_||_)|(/_
@ -36,7 +36,7 @@
#include <type_traits> #include <type_traits>
#include <utility> #include <utility>
#include <continuable/detail/api.hpp> #include <continuable/continuable-api.hpp>
#include <continuable/detail/base.hpp> #include <continuable/detail/base.hpp>
#include <continuable/detail/composition.hpp> #include <continuable/detail/composition.hpp>
#include <continuable/detail/traits.hpp> #include <continuable/detail/traits.hpp>
@ -328,7 +328,7 @@ public:
/// ///
/// \param right The argument on the right-hand side to connect. /// \param right The argument on the right-hand side to connect.
/// ///
/// \returns See the corresponding continuable::then method for the /// \returns See the corresponding continuable_base::then method for the
/// explanation of the return type. /// explanation of the return type.
/// ///
/// \since version 2.0.0 /// \since version 2.0.0

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

@ -1,5 +1,5 @@
/** /*
/~` _ _ _|_. _ _ |_ | _ /~` _ _ _|_. _ _ |_ | _
\_,(_)| | | || ||_|(_||_)|(/_ \_,(_)| | | || ||_|(_||_)|(/_
@ -34,7 +34,7 @@
#include <type_traits> #include <type_traits>
#include <utility> #include <utility>
#include <continuable/detail/api.hpp> #include <continuable/continuable-api.hpp>
#include <continuable/detail/hints.hpp> #include <continuable/detail/hints.hpp>
#include <continuable/detail/types.hpp> #include <continuable/detail/types.hpp>
#include <continuable/detail/util.hpp> #include <continuable/detail/util.hpp>

4
include/continuable/continuable-testing.hpp
View File

@ -1,5 +1,5 @@
/** /*
/~` _ _ _|_. _ _ |_ | _ /~` _ _ _|_. _ _ |_ | _
\_,(_)| | | || ||_|(_||_)|(/_ \_,(_)| | | || ||_|(_||_)|(/_
@ -31,7 +31,7 @@
#ifndef CONTINUABLE_TESTING_HPP_INCLUDED__ #ifndef CONTINUABLE_TESTING_HPP_INCLUDED__
#define CONTINUABLE_TESTING_HPP_INCLUDED__ #define CONTINUABLE_TESTING_HPP_INCLUDED__
#include <continuable/detail/api.hpp> #include <continuable/continuable-api.hpp>
#include <continuable/detail/testing.hpp> #include <continuable/detail/testing.hpp>
#include <continuable/detail/traits.hpp> #include <continuable/detail/traits.hpp>

4
include/continuable/continuable-trait.hpp
View File

@ -1,5 +1,5 @@
/** /*
/~` _ _ _|_. _ _ |_ | _ /~` _ _ _|_. _ _ |_ | _
\_,(_)| | | || ||_|(_||_)|(/_ \_,(_)| | | || ||_|(_||_)|(/_
@ -33,7 +33,7 @@
#include <continuable/continuable-base.hpp> #include <continuable/continuable-base.hpp>
#include <continuable/continuable-promise-base.hpp> #include <continuable/continuable-promise-base.hpp>
#include <continuable/detail/api.hpp> #include <continuable/continuable-api.hpp>
#include <continuable/detail/hints.hpp> #include <continuable/detail/hints.hpp>
#include <continuable/detail/types.hpp> #include <continuable/detail/types.hpp>

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

@ -1,5 +1,5 @@
/** /*
/~` _ _ _|_. _ _ |_ | _ /~` _ _ _|_. _ _ |_ | _
\_,(_)| | | || ||_|(_||_)|(/_ \_,(_)| | | || ||_|(_||_)|(/_
@ -31,7 +31,7 @@
#ifndef CONTINUABLE_TRANSFORMS_HPP_INCLUDED__ #ifndef CONTINUABLE_TRANSFORMS_HPP_INCLUDED__
#define CONTINUABLE_TRANSFORMS_HPP_INCLUDED__ #define CONTINUABLE_TRANSFORMS_HPP_INCLUDED__
#include <continuable/detail/api.hpp> #include <continuable/continuable-api.hpp>
#include <continuable/detail/transforms.hpp> #include <continuable/detail/transforms.hpp>
namespace cti { namespace cti {
@ -48,7 +48,7 @@ namespace cti {
/// | `continuable_base with <Arg>` | `std::future<Arg>` | /// | `continuable_base with <Arg>` | `std::future<Arg>` |
/// | `continuable_base with <Args...>` | `std::future<std::tuple<Args...>>` | /// | `continuable_base with <Args...>` | `std::future<std::tuple<Args...>>` |
/// ///
/// \alert If exceptions are used, exceptions that are thrown, are forwarded /// \attention If exceptions are used, exceptions that are thrown, are forwarded
/// to the returned future. If there are no exceptions supported, /// to the returned future. If there are no exceptions supported,
/// you shall not pass any errors to the end of the asynchronous /// you shall not pass any errors to the end of the asynchronous
/// call chain! /// call chain!
@ -67,7 +67,7 @@ inline auto futurize() {
/// ///
/// \returns Returns a continuable with the same signature as applied to. /// \returns Returns a continuable with the same signature as applied to.
/// ///
/// \note This can be used to create a continuable which doesn't resolve /// \attention This can be used to create a continuable which doesn't resolve
/// the continuation on errors. /// the continuation on errors.
/// ///
/// \since version 2.0.0 /// \since version 2.0.0

4
include/continuable/continuable.hpp
View File

@ -1,5 +1,5 @@
/** /*
/~` _ _ _|_. _ _ |_ | _ /~` _ _ _|_. _ _ |_ | _
\_,(_)| | | || ||_|(_||_)|(/_ \_,(_)| | | || ||_|(_||_)|(/_
@ -33,7 +33,7 @@
#include <function2/function2.hpp> #include <function2/function2.hpp>
#include <continuable/detail/api.hpp> #include <continuable/continuable-api.hpp>
#include <continuable/continuable-trait.hpp> #include <continuable/continuable-trait.hpp>
namespace cti { namespace cti {

4
include/continuable/detail/base.hpp
View File

@ -1,5 +1,5 @@
/** /*
/~` _ _ _|_. _ _ |_ | _ /~` _ _ _|_. _ _ |_ | _
\_,(_)| | | || ||_|(_||_)|(/_ \_,(_)| | | || ||_|(_||_)|(/_
@ -40,7 +40,7 @@
#include <exception> #include <exception>
#endif #endif
#include <continuable/detail/api.hpp> #include <continuable/continuable-api.hpp>
#include <continuable/detail/hints.hpp> #include <continuable/detail/hints.hpp>
#include <continuable/detail/traits.hpp> #include <continuable/detail/traits.hpp>
#include <continuable/detail/types.hpp> #include <continuable/detail/types.hpp>

4
include/continuable/detail/composition.hpp
View File

@ -1,5 +1,5 @@
/** /*
/~` _ _ _|_. _ _ |_ | _ /~` _ _ _|_. _ _ |_ | _
\_,(_)| | | || ||_|(_||_)|(/_ \_,(_)| | | || ||_|(_||_)|(/_
@ -39,7 +39,7 @@
#include <utility> #include <utility>
#include <continuable/continuable-promise-base.hpp> #include <continuable/continuable-promise-base.hpp>
#include <continuable/detail/api.hpp> #include <continuable/continuable-api.hpp>
#include <continuable/detail/base.hpp> #include <continuable/detail/base.hpp>
#include <continuable/detail/hints.hpp> #include <continuable/detail/hints.hpp>
#include <continuable/detail/traits.hpp> #include <continuable/detail/traits.hpp>

2
include/continuable/detail/features.hpp
View File

@ -1,4 +1,4 @@
/** /*
/~` _ _ _|_. _ _ |_ | _ /~` _ _ _|_. _ _ |_ | _
\_,(_)| | | || ||_|(_||_)|(/_ \_,(_)| | | || ||_|(_||_)|(/_

4
include/continuable/detail/hints.hpp
View File

@ -1,5 +1,5 @@
/** /*
/~` _ _ _|_. _ _ |_ | _ /~` _ _ _|_. _ _ |_ | _
\_,(_)| | | || ||_|(_||_)|(/_ \_,(_)| | | || ||_|(_||_)|(/_
@ -33,7 +33,7 @@
#include <type_traits> #include <type_traits>
#include <continuable/detail/api.hpp> #include <continuable/continuable-api.hpp>
#include <continuable/detail/traits.hpp> #include <continuable/detail/traits.hpp>
#include <continuable/detail/util.hpp> #include <continuable/detail/util.hpp>

4
include/continuable/detail/testing.hpp
View File

@ -1,5 +1,5 @@
/** /*
/~` _ _ _|_. _ _ |_ | _ /~` _ _ _|_. _ _ |_ | _
\_,(_)| | | || ||_|(_||_)|(/_ \_,(_)| | | || ||_|(_||_)|(/_
@ -36,7 +36,7 @@
#include <gtest/gtest.h> #include <gtest/gtest.h>
#include <continuable/detail/api.hpp> #include <continuable/continuable-api.hpp>
#include <continuable/detail/traits.hpp> #include <continuable/detail/traits.hpp>
#include <continuable/detail/types.hpp> #include <continuable/detail/types.hpp>
#include <continuable/detail/util.hpp> #include <continuable/detail/util.hpp>

4
include/continuable/detail/traits.hpp
View File

@ -1,5 +1,5 @@
/** /*
/~` _ _ _|_. _ _ |_ | _ /~` _ _ _|_. _ _ |_ | _
\_,(_)| | | || ||_|(_||_)|(/_ \_,(_)| | | || ||_|(_||_)|(/_
@ -37,7 +37,7 @@
#include <type_traits> #include <type_traits>
#include <utility> #include <utility>
#include <continuable/detail/api.hpp> #include <continuable/continuable-api.hpp>
#include <continuable/detail/features.hpp> #include <continuable/detail/features.hpp>
namespace cti { namespace cti {

4
include/continuable/detail/transforms.hpp
View File

@ -1,5 +1,5 @@
/** /*
/~` _ _ _|_. _ _ |_ | _ /~` _ _ _|_. _ _ |_ | _
\_,(_)| | | || ||_|(_||_)|(/_ \_,(_)| | | || ||_|(_||_)|(/_
@ -33,7 +33,7 @@
#include <future> #include <future>
#include <continuable/detail/api.hpp> #include <continuable/continuable-api.hpp>
#include <continuable/detail/base.hpp> #include <continuable/detail/base.hpp>
#include <continuable/detail/features.hpp> #include <continuable/detail/features.hpp>
#include <continuable/detail/hints.hpp> #include <continuable/detail/hints.hpp>

4
include/continuable/detail/types.hpp
View File

@ -1,5 +1,5 @@
/** /*
/~` _ _ _|_. _ _ |_ | _ /~` _ _ _|_. _ _ |_ | _
\_,(_)| | | || ||_|(_||_)|(/_ \_,(_)| | | || ||_|(_||_)|(/_
@ -39,7 +39,7 @@
#endif // CONTINUABLE_WITH_NO_EXCEPTIONS #endif // CONTINUABLE_WITH_NO_EXCEPTIONS
#endif // CONTINUABLE_WITH_CUSTOM_ERROR_TYPE #endif // CONTINUABLE_WITH_CUSTOM_ERROR_TYPE
#include <continuable/detail/api.hpp> #include <continuable/continuable-api.hpp>
#include <continuable/detail/features.hpp> #include <continuable/detail/features.hpp>
namespace cti { namespace cti {

4
include/continuable/detail/util.hpp
View File

@ -1,5 +1,5 @@
/** /*
/~` _ _ _|_. _ _ |_ | _ /~` _ _ _|_. _ _ |_ | _
\_,(_)| | | || ||_|(_||_)|(/_ \_,(_)| | | || ||_|(_||_)|(/_
@ -36,7 +36,7 @@
#include <type_traits> #include <type_traits>
#include <utility> #include <utility>
#include <continuable/detail/api.hpp> #include <continuable/continuable-api.hpp>
#include <continuable/detail/features.hpp> #include <continuable/detail/features.hpp>
#include <continuable/detail/traits.hpp> #include <continuable/detail/traits.hpp>

2
test/mock/test-mock.cpp
View File

@ -1,4 +1,4 @@
/** /*
Copyright(c) 2015 - 2017 Denis Blank <denis.blank at outlook dot com> Copyright(c) 2015 - 2017 Denis Blank <denis.blank at outlook dot com>
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy

2
test/playground/test-playground.cpp
View File

@ -1,4 +1,4 @@
/** /*
Copyright(c) 2015 - 2017 Denis Blank <denis.blank at outlook dot com> Copyright(c) 2015 - 2017 Denis Blank <denis.blank at outlook dot com>
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy

2
test/threads/test-threads.cpp
View File

@ -1,5 +1,5 @@
/** /*
Copyright(c) 2015 - 2017 Denis Blank <denis.blank at outlook dot com> Copyright(c) 2015 - 2017 Denis Blank <denis.blank at outlook dot com>
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy

2
test/unit-test/test-continuable-base-chaining.cpp
View File

@ -1,5 +1,5 @@
/** /*
Copyright(c) 2015 - 2017 Denis Blank <denis.blank at outlook dot com> Copyright(c) 2015 - 2017 Denis Blank <denis.blank at outlook dot com>
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy

2
test/unit-test/test-continuable-base-destruct.cpp
View File

@ -1,5 +1,5 @@
/** /*
Copyright(c) 2015 - 2017 Denis Blank <denis.blank at outlook dot com> Copyright(c) 2015 - 2017 Denis Blank <denis.blank at outlook dot com>
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy

2
test/unit-test/test-continuable-base-errors.cpp
View File

@ -1,5 +1,5 @@
/** /*
Copyright(c) 2015 - 2017 Denis Blank <denis.blank at outlook dot com> Copyright(c) 2015 - 2017 Denis Blank <denis.blank at outlook dot com>
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy

2
test/unit-test/test-continuable-base-partial.cpp
View File

@ -1,5 +1,5 @@
/** /*
Copyright(c) 2015 - 2017 Denis Blank <denis.blank at outlook dot com> Copyright(c) 2015 - 2017 Denis Blank <denis.blank at outlook dot com>
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy

2
test/unit-test/test-continuable-connection-all.cpp
View File

@ -1,5 +1,5 @@
/** /*
Copyright(c) 2015 - 2017 Denis Blank <denis.blank at outlook dot com> Copyright(c) 2015 - 2017 Denis Blank <denis.blank at outlook dot com>
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy

2
test/unit-test/test-continuable-connection-any.cpp
View File

@ -1,5 +1,5 @@
/** /*
Copyright(c) 2015 - 2017 Denis Blank <denis.blank at outlook dot com> Copyright(c) 2015 - 2017 Denis Blank <denis.blank at outlook dot com>
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy

2
test/unit-test/test-continuable-connection-seq.cpp
View File

@ -1,5 +1,5 @@
/** /*
Copyright(c) 2015 - 2017 Denis Blank <denis.blank at outlook dot com> Copyright(c) 2015 - 2017 Denis Blank <denis.blank at outlook dot com>
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy

2
test/unit-test/test-continuable-erasure.cpp
View File

@ -1,5 +1,5 @@
/** /*
Copyright(c) 2015 - 2017 Denis Blank <denis.blank at outlook dot com> Copyright(c) 2015 - 2017 Denis Blank <denis.blank at outlook dot com>
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy

2
test/unit-test/test-continuable-regression.cpp
View File

@ -1,5 +1,5 @@
/** /*
Copyright(c) 2015 - 2017 Denis Blank <denis.blank at outlook dot com> Copyright(c) 2015 - 2017 Denis Blank <denis.blank at outlook dot com>
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy

2
test/unit-test/test-continuable-transforms.cpp
View File

@ -1,5 +1,5 @@
/** /*
Copyright(c) 2015 - 2017 Denis Blank <denis.blank at outlook dot com> Copyright(c) 2015 - 2017 Denis Blank <denis.blank at outlook dot com>
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy

2
test/unit-test/test-continuable.cpp
View File

@ -1,5 +1,5 @@
/** /*
Copyright(c) 2015 - 2017 Denis Blank <denis.blank at outlook dot com> Copyright(c) 2015 - 2017 Denis Blank <denis.blank at outlook dot com>
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy

2
test/unit-test/test-continuable.hpp
View File

@ -1,5 +1,5 @@
/** /*
Copyright(c) 2015 - 2017 Denis Blank <denis.blank at outlook dot com> Copyright(c) 2015 - 2017 Denis Blank <denis.blank at outlook dot com>
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy