Skip to content

Commit

Permalink
#1051: vrt-collection: Add doxygen documentation for invokable struct
Browse files Browse the repository at this point in the history
  • Loading branch information
JacobDomagala committed Dec 14, 2020
1 parent 9a40cd5 commit a31022f
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions src/vt/vrt/collection/invoke/invokable.h
Original file line number Diff line number Diff line change
Expand Up @@ -58,17 +58,35 @@ struct Invokable : BaseProxyT {
typename BaseProxyT::ElementProxyType const& in_elm
);

/**
* \brief Invoke member message handler on a collection element
* The function will be invoked inline without going through scheduler
*
* \param[in] args arguments for creating the message
*/
template <
typename MsgT, ActiveColMemberTypedFnType<MsgT, ColT> f, typename... Args
>
void invoke(Args&&... args) const;

/**
* \brief Invoke message handler on a collection element
* The function will be invoked inline without going through scheduler
*
* \param[in] args arguments for creating the message
*/
template <
typename MsgT, ActiveColTypedFnType<MsgT, typename MsgT::CollectionType>* f,
typename... Args
>
void invoke(Args&&... args) const;

/**
* \brief Invoke function 'f' on a collection element
* The function will be invoked inline without going through scheduler
*
* \param[in] args function arguments
*/
template <typename Type, Type f, typename... Args>
decltype(auto) invoke(Args&&... args) const;
};
Expand Down

0 comments on commit a31022f

Please sign in to comment.