From e46fe67b2c1965f0ef0dd4ec0335e34cf1f29087 Mon Sep 17 00:00:00 2001
From: Jakub Domagala <domagala.jacob@gmail.com>
Date: Sun, 20 Sep 2020 20:23:04 +0200
Subject: [PATCH] #1024: Add doxygen documentation for functions

---
 src/vt/vrt/collection/manager.h | 33 ++++++++++++++++++++++++++++++++-
 1 file changed, 32 insertions(+), 1 deletion(-)

diff --git a/src/vt/vrt/collection/manager.h b/src/vt/vrt/collection/manager.h
index f1ad7b2479..d365700751 100644
--- a/src/vt/vrt/collection/manager.h
+++ b/src/vt/vrt/collection/manager.h
@@ -904,6 +904,16 @@ 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>
@@ -911,6 +921,16 @@ struct CollectionManager
     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>
@@ -918,9 +938,20 @@ struct CollectionManager
     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