From cb4497ef1d4ba571763aab469a5e572907b08be0 Mon Sep 17 00:00:00 2001 From: Denis Blank Date: Fri, 9 Mar 2018 11:19:36 +0100 Subject: [PATCH] Fix the remaining doxygen warnings --- doc/Index.md | 1 - include/continuable/detail/base.hpp | 3 +++ include/continuable/detail/traverse.hpp | 6 +++++- 3 files changed, 8 insertions(+), 2 deletions(-) diff --git a/doc/Index.md b/doc/Index.md index 8620d43..e8b64b8 100644 --- a/doc/Index.md +++ b/doc/Index.md @@ -27,7 +27,6 @@ - **Predefined (erased) types** - Predefined type erarasures for continuables and promises - \link cti::promise promise\endlink - \copybrief cti::promise - \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. - \link cti::continuable_trait::promise promise\endlink - \copybrief cti::continuable_trait::promise - \link cti::continuable_trait::continuable continuable\endlink - \copybrief cti::continuable_trait::continuable diff --git a/include/continuable/detail/base.hpp b/include/continuable/detail/base.hpp index 4a54c95..e717a7a 100644 --- a/include/continuable/detail/base.hpp +++ b/include/continuable/detail/base.hpp @@ -295,12 +295,15 @@ enum class handle_results { 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 enum class handle_errors { no, //< The error is forwarded to the next callable plain, //< The error is the only argument accepted by the callable forward //< The error is forwarded to the callable while keeping its tag }; +/// \endcond namespace callbacks { namespace proto { diff --git a/include/continuable/detail/traverse.hpp b/include/continuable/detail/traverse.hpp index ecd0923..4d2f98a 100644 --- a/include/continuable/detail/traverse.hpp +++ b/include/continuable/detail/traverse.hpp @@ -46,6 +46,7 @@ namespace detail { namespace traversal { /// Exposes useful facilities for dealing with 1:n mappings namespace spreading { +/// \cond false /// A struct to mark a tuple to be unpacked into the parent context template class spread_box { @@ -203,7 +204,7 @@ template constexpr auto apply_spread_impl(std::false_type, C&& callable, T&&... args) -> decltype(std::forward(callable)(std::forward(args)...)) { return std::forward(callable)(std::forward(args)...); -} // namespace spreading +} /// Deduces to a true_type if any of the given types marks /// the underlying type to be spread into the current context. @@ -269,6 +270,7 @@ template constexpr decltype(auto) tupelize_or_void(T&&... args) { return voidify_empty_tuple(tupelize(std::forward(args)...)); } +/// \endcond } // namespace spreading /// Just traverses the pack with the given callable object, @@ -517,6 +519,7 @@ auto remap_container(container_mapping_tag, M&& mapper, return spreading::empty_spread(); } +/// \cond false /// Remaps the content of the given container with type T, /// to a container of the same type which may contain /// different types. @@ -530,6 +533,7 @@ auto remap( return remap_container(container_mapping_tag_of_t{}, std::forward(mapper), std::forward(container)); } +/// \endcond /// Just call the visitor with the content of the container template