Skip to content

Hide noexcept function_traits specializations from Doxygen #3367

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mjcarroll merged 1 commit into from
Oct 20, 2026
+10 −0
Merged

Hide noexcept function_traits specializations from Doxygen #3367

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions rclcpp/include/rclcpp/function_traits.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ template<typename ReturnTypeT, typename ... Args>
struct function_traits<ReturnTypeT (*)(Args ...)>: function_traits<ReturnTypeT(Args ...)>
{};

/// \cond
// noexcept is part of the function type since C++17, so the noexcept variants need their own
// specializations.
template<typename ReturnTypeT, typename ... Args>
Expand All @@ -87,6 +88,7 @@ struct function_traits<ReturnTypeT(Args ...) noexcept>: function_traits<ReturnTy
template<typename ReturnTypeT, typename ... Args>
struct function_traits<ReturnTypeT (*)(Args ...) noexcept>: function_traits<ReturnTypeT(Args ...)>
{};
/// \endcond

// std::bind for object methods
template<typename ClassT, typename ReturnTypeT, typename ... Args, typename ... FArgs>
Expand Down Expand Up @@ -126,6 +128,7 @@ struct function_traits<
: function_traits<ReturnTypeT(Args ...)>
{};

/// \cond
// std::bind for object noexcept methods
template<typename ClassT, typename ReturnTypeT, typename ... Args, typename ... FArgs>
#if defined DOXYGEN_ONLY
Expand All @@ -145,7 +148,9 @@ struct function_traits<
#endif
: function_traits<ReturnTypeT(Args ...)>
{};
/// \endcond

/// \cond
// std::bind for object const noexcept methods
template<typename ClassT, typename ReturnTypeT, typename ... Args, typename ... FArgs>
#if defined DOXYGEN_ONLY
Expand All @@ -165,6 +170,7 @@ struct function_traits<
#endif
: function_traits<ReturnTypeT(Args ...)>
{};
/// \endcond

// std::bind for free functions
template<typename ReturnTypeT, typename ... Args, typename ... FArgs>
Expand All @@ -182,6 +188,7 @@ struct function_traits<std::_Binder<std::_Unforced, ReturnTypeT( &)(Args ...), F
: function_traits<ReturnTypeT(Args ...)>
{};

/// \cond
// std::bind for noexcept free functions
template<typename ReturnTypeT, typename ... Args, typename ... FArgs>
#if defined DOXYGEN_ONLY
Expand All @@ -198,17 +205,20 @@ struct function_traits<
#endif
: function_traits<ReturnTypeT(Args ...)>
{};
/// \endcond

// Lambdas
template<typename ClassT, typename ReturnTypeT, typename ... Args>
struct function_traits<ReturnTypeT (ClassT::*)(Args ...) const>
: function_traits<ReturnTypeT(ClassT &, Args ...)>
{};

/// \cond
template<typename ClassT, typename ReturnTypeT, typename ... Args>
struct function_traits<ReturnTypeT (ClassT::*)(Args ...) const noexcept>
: function_traits<ReturnTypeT(ClassT &, Args ...)>
{};
/// \endcond

template<typename FunctionT>
struct function_traits<FunctionT &>: function_traits<FunctionT>
Expand Down
Loading