Skip to content

Commit

Permalink
#1024: Add doxygen documentation for functions
Browse files Browse the repository at this point in the history
  • Loading branch information
JacobDomagala authored and Braden Mailloux committed Oct 15, 2020
1 parent 8266ebd commit 1d97040
Showing 1 changed file with 32 additions and 1 deletion.
33 changes: 32 additions & 1 deletion src/vt/vrt/collection/manager.h
Original file line number Diff line number Diff line change
Expand Up @@ -948,23 +948,54 @@ struct CollectionManager
bool instrument
);

/**
* \brief Broadcast collective a message with action function handler
*
* \param[in] proxy the collection proxy
* \param[in] msg the message
* \param[in] instrument whether to instrument the broadcast for load
* balancing (some system calls use this to disable instrumentation)
*
* \return a pending send
*/
template <
typename MsgT,
ActiveColTypedFnType<MsgT,typename MsgT::CollectionType> *f>
messaging::PendingSend broadcastMsgCollective(
CollectionProxyWrapType<typename MsgT::CollectionType> const& proxy,
MsgT* msg, bool instrument = true);

/**
* \brief Broadcast collective a message with action member handler
*
* \param[in] proxy the collection proxy
* \param[in] msg the message
* \param[in] instrument whether to instrument the broadcast for load
* balancing (some system calls use this to disable instrumentation)
*
* \return a pending send
*/
template <
typename MsgT,
ActiveColMemberTypedFnType<MsgT, typename MsgT::CollectionType> f>
messaging::PendingSend broadcastMsgCollective(
CollectionProxyWrapType<typename MsgT::CollectionType> const& proxy,
MsgT* msg, bool instrument = true);

/**
* \internal \brief Broadcast collective a message
*
* \param[in] proxy the collection proxy
* \param[in] msg the message
* \param[in] instrument whether to instrument the broadcast for load
* balancing (some system calls use this to disable instrumentation)
*
* \return a pending send
*/
template <typename MsgT, typename ColT>
messaging::PendingSend broadcastMsgCollectiveImpl(
CollectionProxyWrapType<ColT> const& proxy, MsgT* msg);
CollectionProxyWrapType<ColT> const& proxy, MsgT* msg,
bool instrument = true);

/**
* \brief Broadcast a message with action function handler
Expand Down

0 comments on commit 1d97040

Please sign in to comment.