coffee/continuable
1
0
Fork 0
mirror of https://github.com/Naios/continuable.git synced 2026-02-16 23:29:48 +08:00
Code Issues Packages Projects Releases Wiki Activity

Fix the remaining doxygen warnings

Browse Source
This commit is contained in:
Denis Blank 2018-03-09 11:19:36 +01:00
parent 17b0f7544d
commit cb4497ef1d
3 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/Index.md
View File

@ -27,7 +27,6 @@
- **Predefined (erased) types** - 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
- **Class cti::continuable_trait** - A trait class for defining your own cti::continuable_base trait with the type-erasure backend of your choice. - **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::promise promise\endlink - \copybrief cti::continuable_trait::promise - \link cti::continuable_trait::promise promise\endlink - \copybrief cti::continuable_trait::promise
- \link cti::continuable_trait::continuable continuable\endlink - \copybrief cti::continuable_trait::continuable - \link cti::continuable_trait::continuable continuable\endlink - \copybrief cti::continuable_trait::continuable

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

@ -295,12 +295,15 @@ enum class handle_results {
yes //< The result is handled by the current callable yes //< The result is handled by the current callable
}; };
// Silences a doxygen bug, it tries to map forward to std::forward
/// \cond false
/// Tells whether we handle the error through the callback /// Tells whether we handle the error through the callback
enum class handle_errors { enum class handle_errors {
no, //< The error is forwarded to the next callable no, //< The error is forwarded to the next callable
plain, //< The error is the only argument accepted by the callable plain, //< The error is the only argument accepted by the callable
forward //< The error is forwarded to the callable while keeping its tag forward //< The error is forwarded to the callable while keeping its tag
}; };
/// \endcond
namespace callbacks { namespace callbacks {
namespace proto { namespace proto {

6
include/continuable/detail/traverse.hpp
View File

@ -46,6 +46,7 @@ namespace detail {
namespace traversal { namespace traversal {
/// Exposes useful facilities for dealing with 1:n mappings /// Exposes useful facilities for dealing with 1:n mappings
namespace spreading { namespace spreading {
/// \cond false
/// A struct to mark a tuple to be unpacked into the parent context /// A struct to mark a tuple to be unpacked into the parent context
template <typename... T> template <typename... T>
class spread_box { class spread_box {
@ -203,7 +204,7 @@ template <typename C, typename... T>
constexpr auto apply_spread_impl(std::false_type, C&& callable, T&&... args) constexpr auto apply_spread_impl(std::false_type, C&& callable, T&&... args)
-> decltype(std::forward<C>(callable)(std::forward<T>(args)...)) { -> decltype(std::forward<C>(callable)(std::forward<T>(args)...)) {
return std::forward<C>(callable)(std::forward<T>(args)...); return std::forward<C>(callable)(std::forward<T>(args)...);
} // namespace spreading }
/// Deduces to a true_type if any of the given types marks /// Deduces to a true_type if any of the given types marks
/// the underlying type to be spread into the current context. /// the underlying type to be spread into the current context.
@ -269,6 +270,7 @@ template <typename... T>
constexpr decltype(auto) tupelize_or_void(T&&... args) { constexpr decltype(auto) tupelize_or_void(T&&... args) {
return voidify_empty_tuple(tupelize(std::forward<T>(args)...)); return voidify_empty_tuple(tupelize(std::forward<T>(args)...));
} }
/// \endcond
} // namespace spreading } // namespace spreading
/// Just traverses the pack with the given callable object, /// Just traverses the pack with the given callable object,
@ -517,6 +519,7 @@ auto remap_container(container_mapping_tag<true, false>, M&& mapper,
return spreading::empty_spread(); return spreading::empty_spread();
} }
/// \cond false
/// Remaps the content of the given container with type T, /// Remaps the content of the given container with type T,
/// to a container of the same type which may contain /// to a container of the same type which may contain
/// different types. /// different types.
@ -530,6 +533,7 @@ auto remap(
return remap_container(container_mapping_tag_of_t<T, M>{}, return remap_container(container_mapping_tag_of_t<T, M>{},
std::forward<M>(mapper), std::forward<T>(container)); std::forward<M>(mapper), std::forward<T>(container));
} }
/// \endcond
/// Just call the visitor with the content of the container /// Just call the visitor with the content of the container
template <typename T, typename M> template <typename T, typename M>