Move the documentation code to doc

CMakeLists.txt

@@ -58,7 +58,7 @@ if (CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR)
 
   include(cmake/CMakeLists.txt)
 
-
+  add_subdirectory(doc)
   add_subdirectory(examples)
   add_subdirectory(test)
 endif ()

doc/CMakeLists.txt

@@ -0,0 +1 @@
+add_subdirectory(code)

doc/code/CMakeLists.txt

@@ -0,0 +1,2 @@
+add_subdirectory(documentation)
+add_subdirectory(slideshow)

doc/code/documentation/CMakeLists.txt

@@ -0,0 +1,5 @@
+add_executable(doc-documentation
+  ${CMAKE_CURRENT_LIST_DIR}/doc-documentation.cpp)
+target_link_libraries(doc-documentation
+  PRIVATE
+    continuable)

doc/code/slideshow/CMakeLists.txt

@@ -0,0 +1,5 @@
+add_executable(doc-slideshow
+  ${CMAKE_CURRENT_LIST_DIR}/doc-slideshow.cpp)
+target_link_libraries(doc-slideshow
+  PRIVATE
+    continuable)

examples/CMakeLists.txt

@@ -1,2 +0,0 @@
-add_subdirectory(documentation)
-add_subdirectory(slideshow)

examples/documentation/CMakeLists.txt

@@ -1,5 +0,0 @@
-add_executable(example-documentation
-  ${CMAKE_CURRENT_LIST_DIR}/example-documentation.cpp)
-target_link_libraries(example-documentation
-  PRIVATE
-    continuable)

examples/slideshow/CMakeLists.txt

@@ -1,5 +0,0 @@
-add_executable(example-slideshow
-  ${CMAKE_CURRENT_LIST_DIR}/example-slideshow.cpp)
-target_link_libraries(example-slideshow
-  PRIVATE
-    continuable)

include/continuable/continuable-base.hpp

@@ -579,8 +579,8 @@ private:
 /// which represents the object invokable with the asynchronous result of this
 /// continuable.
 /// ```cpp
-/// auto ct = cti::make_continuable([](auto&& callback) {
-///   std::forward<decltype(callback)>(callback)("result");
+/// auto ct = cti::make_continuable([](auto&& promise) {
+///   promise.set_value("result");
 /// });
 /// ```
 /// The callback may be stored or moved.
@@ -589,14 +589,14 @@ private:
 /// It's recommended to accept any callback instead of erasing it.
 /// ```cpp
 /// // Good practice:
-/// auto ct = cti::make_continuable([](auto&& callback) {
-///   std::forward<decltype(callback)>(callback)("result");
+/// auto ct = cti::make_continuable([](auto&& promise) {
+///   promise.set_value("result");
 /// });
 ///
 /// // Good practice using a functional object:
 /// struct Continuation {
 ///   template<typename T>
-///   void operator() (T&& continuation) const {
+///   void operator() (T&& continuation) && {
 ///     // ...
 ///   }
 /// }
@@ -605,8 +605,8 @@ private:
 ///
 /// // Bad practice (because of unnecessary type erasure):
 /// auto ct = cti::make_continuable(
-///   [](std::function<void(std::string)> callback) {
-///     callback("result");
+///   [](cti::promise<std::string> promise) {
+///     promise.set_value("result");
 ///   });
 /// ```
 ///