Improve the documentation

2025-12-06 16:56:44 +08:00 · 2017-10-04 19:07:20 +02:00 · 2017-10-04 19:07:20 +02:00 · f3c33b58c6
commit f3c33b58c6
parent 2b061a6058
36 changed files with 2515 additions and 59 deletions
--- a/.gitignore
+++ b/.gitignore
@ -47,6 +47,3 @@ bld/

 # Visual Studo 2015 cache/options directory
 .vs/
-
-doc/doxygen/
-
--- a/doc/code/documentation/doc-documentation.cpp
+++ b/doc/code/documentation/doc-documentation.cpp
@ -1,4 +1,4 @@
-/**
+/*
  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
--- a/doc/code/slideshow/doc-slideshow.cpp
+++ b/doc/code/slideshow/doc-slideshow.cpp
@ -1,4 +1,4 @@
-/**
+/*
  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
--- a/doc/doxygen/.gitignore
+++ b/doc/doxygen/.gitignore
@ -0,0 +1 @@
+doxygen/
--- a/doc/doxygen/Doxyfile
+++ b/doc/doxygen/Doxyfile
--- a/include/continuable/continuable-api.hpp
+++ b/include/continuable/continuable-api.hpp
@ -1,5 +1,5 @@

-/**
+/*

                        /~` _  _ _|_. _     _ |_ | _
                        \_,(_)| | | || ||_|(_||_)|(/_
@ -26,7 +26,7 @@
  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
  SOFTWARE.
-**/
+*/

 #ifndef CONTINUABLE_DETAIL_API_HPP_INCLUDED__
 #define CONTINUABLE_DETAIL_API_HPP_INCLUDED__
--- a/include/continuable/continuable-base.hpp
+++ b/include/continuable/continuable-base.hpp
@ -1,5 +1,5 @@

-/**
+/*

                        /~` _  _ _|_. _     _ |_ | _
                        \_,(_)| | | || ||_|(_||_)|(/_
@ -36,7 +36,7 @@
 #include <type_traits>
 #include <utility>

-#include <continuable/detail/api.hpp>
+#include <continuable/continuable-api.hpp>
 #include <continuable/detail/base.hpp>
 #include <continuable/detail/composition.hpp>
 #include <continuable/detail/traits.hpp>
@ -328,7 +328,7 @@ public:
  ///
  /// \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.
  ///
  /// \since version 2.0.0
--- a/include/continuable/continuable-promise-base.hpp
+++ b/include/continuable/continuable-promise-base.hpp
@ -1,5 +1,5 @@

-/**
+/*

                        /~` _  _ _|_. _     _ |_ | _
                        \_,(_)| | | || ||_|(_||_)|(/_
@ -34,7 +34,7 @@
 #include <type_traits>
 #include <utility>

-#include <continuable/detail/api.hpp>
+#include <continuable/continuable-api.hpp>
 #include <continuable/detail/hints.hpp>
 #include <continuable/detail/types.hpp>
 #include <continuable/detail/util.hpp>
--- a/include/continuable/continuable-testing.hpp
+++ b/include/continuable/continuable-testing.hpp
@ -1,5 +1,5 @@

-/**
+/*

                        /~` _  _ _|_. _     _ |_ | _
                        \_,(_)| | | || ||_|(_||_)|(/_
@ -31,7 +31,7 @@
 #ifndef 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/traits.hpp>

--- a/include/continuable/continuable-trait.hpp
+++ b/include/continuable/continuable-trait.hpp
@ -1,5 +1,5 @@

-/**
+/*

                        /~` _  _ _|_. _     _ |_ | _
                        \_,(_)| | | || ||_|(_||_)|(/_
@ -33,7 +33,7 @@

 #include <continuable/continuable-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/types.hpp>

--- a/include/continuable/continuable-transforms.hpp
+++ b/include/continuable/continuable-transforms.hpp
@ -1,5 +1,5 @@

-/**
+/*

                        /~` _  _ _|_. _     _ |_ | _
                        \_,(_)| | | || ||_|(_||_)|(/_
@ -31,7 +31,7 @@
 #ifndef CONTINUABLE_TRANSFORMS_HPP_INCLUDED__
 #define CONTINUABLE_TRANSFORMS_HPP_INCLUDED__

-#include <continuable/detail/api.hpp>
+#include <continuable/continuable-api.hpp>
 #include <continuable/detail/transforms.hpp>

 namespace cti {
@ -48,7 +48,7 @@ namespace cti {
 /// | `continuable_base with <Arg>`     | `std::future<Arg>`                 |
 /// | `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,
 ///            you shall not pass any errors to the end of the asynchronous
 ///            call chain!
@ -67,7 +67,7 @@ inline auto futurize() {
 ///
 /// \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.
 ///
 /// \since version 2.0.0
--- a/include/continuable/continuable.hpp
+++ b/include/continuable/continuable.hpp
@ -1,5 +1,5 @@

-/**
+/*

                        /~` _  _ _|_. _     _ |_ | _
                        \_,(_)| | | || ||_|(_||_)|(/_
@ -33,7 +33,7 @@

 #include <function2/function2.hpp>

-#include <continuable/detail/api.hpp>
+#include <continuable/continuable-api.hpp>
 #include <continuable/continuable-trait.hpp>

 namespace cti {
--- a/include/continuable/detail/base.hpp
+++ b/include/continuable/detail/base.hpp
@ -1,5 +1,5 @@

-/**
+/*

                        /~` _  _ _|_. _     _ |_ | _
                        \_,(_)| | | || ||_|(_||_)|(/_
@ -40,7 +40,7 @@
 #include <exception>
 #endif

-#include <continuable/detail/api.hpp>
+#include <continuable/continuable-api.hpp>
 #include <continuable/detail/hints.hpp>
 #include <continuable/detail/traits.hpp>
 #include <continuable/detail/types.hpp>
--- a/include/continuable/detail/composition.hpp
+++ b/include/continuable/detail/composition.hpp
@ -1,5 +1,5 @@

-/**
+/*

                        /~` _  _ _|_. _     _ |_ | _
                        \_,(_)| | | || ||_|(_||_)|(/_
@ -39,7 +39,7 @@
 #include <utility>

 #include <continuable/continuable-promise-base.hpp>
-#include <continuable/detail/api.hpp>
+#include <continuable/continuable-api.hpp>
 #include <continuable/detail/base.hpp>
 #include <continuable/detail/hints.hpp>
 #include <continuable/detail/traits.hpp>
--- a/include/continuable/detail/features.hpp
+++ b/include/continuable/detail/features.hpp
@ -1,4 +1,4 @@
-/**
+/*

                        /~` _  _ _|_. _     _ |_ | _
                        \_,(_)| | | || ||_|(_||_)|(/_
--- a/include/continuable/detail/hints.hpp
+++ b/include/continuable/detail/hints.hpp
@ -1,5 +1,5 @@

-/**
+/*

                        /~` _  _ _|_. _     _ |_ | _
                        \_,(_)| | | || ||_|(_||_)|(/_
@ -33,7 +33,7 @@

 #include <type_traits>

-#include <continuable/detail/api.hpp>
+#include <continuable/continuable-api.hpp>
 #include <continuable/detail/traits.hpp>
 #include <continuable/detail/util.hpp>

--- a/include/continuable/detail/testing.hpp
+++ b/include/continuable/detail/testing.hpp
@ -1,5 +1,5 @@

-/**
+/*

                        /~` _  _ _|_. _     _ |_ | _
                        \_,(_)| | | || ||_|(_||_)|(/_
@ -36,7 +36,7 @@

 #include <gtest/gtest.h>

-#include <continuable/detail/api.hpp>
+#include <continuable/continuable-api.hpp>
 #include <continuable/detail/traits.hpp>
 #include <continuable/detail/types.hpp>
 #include <continuable/detail/util.hpp>
--- a/include/continuable/detail/traits.hpp
+++ b/include/continuable/detail/traits.hpp
@ -1,5 +1,5 @@

-/**
+/*

                        /~` _  _ _|_. _     _ |_ | _
                        \_,(_)| | | || ||_|(_||_)|(/_
@ -37,7 +37,7 @@
 #include <type_traits>
 #include <utility>

-#include <continuable/detail/api.hpp>
+#include <continuable/continuable-api.hpp>
 #include <continuable/detail/features.hpp>

 namespace cti {
--- a/include/continuable/detail/transforms.hpp
+++ b/include/continuable/detail/transforms.hpp
@ -1,5 +1,5 @@

-/**
+/*

                        /~` _  _ _|_. _     _ |_ | _
                        \_,(_)| | | || ||_|(_||_)|(/_
@ -33,7 +33,7 @@

 #include <future>

-#include <continuable/detail/api.hpp>
+#include <continuable/continuable-api.hpp>
 #include <continuable/detail/base.hpp>
 #include <continuable/detail/features.hpp>
 #include <continuable/detail/hints.hpp>
--- a/include/continuable/detail/types.hpp
+++ b/include/continuable/detail/types.hpp
@ -1,5 +1,5 @@

-/**
+/*

                        /~` _  _ _|_. _     _ |_ | _
                        \_,(_)| | | || ||_|(_||_)|(/_
@ -39,7 +39,7 @@
 #endif // CONTINUABLE_WITH_NO_EXCEPTIONS
 #endif // CONTINUABLE_WITH_CUSTOM_ERROR_TYPE

-#include <continuable/detail/api.hpp>
+#include <continuable/continuable-api.hpp>
 #include <continuable/detail/features.hpp>

 namespace cti {
--- a/include/continuable/detail/util.hpp
+++ b/include/continuable/detail/util.hpp
@ -1,5 +1,5 @@

-/**
+/*

                        /~` _  _ _|_. _     _ |_ | _
                        \_,(_)| | | || ||_|(_||_)|(/_
@ -36,7 +36,7 @@
 #include <type_traits>
 #include <utility>

-#include <continuable/detail/api.hpp>
+#include <continuable/continuable-api.hpp>
 #include <continuable/detail/features.hpp>
 #include <continuable/detail/traits.hpp>

--- a/test/mock/test-mock.cpp
+++ b/test/mock/test-mock.cpp
@ -1,4 +1,4 @@
-/**
+/*
  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
--- a/test/playground/test-playground.cpp
+++ b/test/playground/test-playground.cpp
@ -1,4 +1,4 @@
-/**
+/*
  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
--- a/test/threads/test-threads.cpp
+++ b/test/threads/test-threads.cpp
@ -1,5 +1,5 @@

-/**
+/*
  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
--- a/test/unit-test/test-continuable-base-chaining.cpp
+++ b/test/unit-test/test-continuable-base-chaining.cpp
@ -1,5 +1,5 @@

-/**
+/*
  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
--- a/test/unit-test/test-continuable-base-destruct.cpp
+++ b/test/unit-test/test-continuable-base-destruct.cpp
@ -1,5 +1,5 @@

-/**
+/*
  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
--- a/test/unit-test/test-continuable-base-errors.cpp
+++ b/test/unit-test/test-continuable-base-errors.cpp
@ -1,5 +1,5 @@

-/**
+/*
  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
--- a/test/unit-test/test-continuable-base-partial.cpp
+++ b/test/unit-test/test-continuable-base-partial.cpp
@ -1,5 +1,5 @@

-/**
+/*
  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
--- a/test/unit-test/test-continuable-connection-all.cpp
+++ b/test/unit-test/test-continuable-connection-all.cpp
@ -1,5 +1,5 @@

-/**
+/*
  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
--- a/test/unit-test/test-continuable-connection-any.cpp
+++ b/test/unit-test/test-continuable-connection-any.cpp
@ -1,5 +1,5 @@

-/**
+/*
  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
--- a/test/unit-test/test-continuable-connection-seq.cpp
+++ b/test/unit-test/test-continuable-connection-seq.cpp
@ -1,5 +1,5 @@

-/**
+/*
  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
--- a/test/unit-test/test-continuable-erasure.cpp
+++ b/test/unit-test/test-continuable-erasure.cpp
@ -1,5 +1,5 @@

-/**
+/*
  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
--- a/test/unit-test/test-continuable-regression.cpp
+++ b/test/unit-test/test-continuable-regression.cpp
@ -1,5 +1,5 @@

-/**
+/*
  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
--- a/test/unit-test/test-continuable-transforms.cpp
+++ b/test/unit-test/test-continuable-transforms.cpp
@ -1,5 +1,5 @@

-/**
+/*
  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
--- a/test/unit-test/test-continuable.cpp
+++ b/test/unit-test/test-continuable.cpp
@ -1,5 +1,5 @@

-/**
+/*
  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
--- a/test/unit-test/test-continuable.hpp
+++ b/test/unit-test/test-continuable.hpp
@ -1,5 +1,5 @@

-/**
+/*
  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