Updated comments for helper functions

Author: TejaX-Alaghari

clang/runtime/dpct-rt/include/dpct/shmem_utils.hpp

@@ -11,30 +11,32 @@
 
 namespace dpct::shmem {
 
-/// Initialize Intel SHMEM runtime based on exisiting communicator in attributes
+/// Initialize Intel SHMEM library based on exisiting communicator
 /// \param [in] runtime_flags specify the underlying communicator like MPI/
 /// OpenSHMEM to initialize iSHMEM for launcher agnostic bootstrapping
-/// \param [in] attr attributes of existing communicator
-void init_attr(unsigned runtime_flags, ishmemx_attr_t *attr) {
+/// \param [in] attr Additional attributes for initializing the iSHMEM library.
+void init_attr(ishmemx_runtime_type_t runtime_flags, ishmemx_attr_t *attr) {
   if (runtime_flags == 0) {
     // if no runtime flags are present, initialize iSHMEM normally
     ishmem_init();
   } else {
-    attr->runtime = static_cast<ishmemx_runtime_type_t>(runtime_flags);
+    attr->runtime = runtime_flags;
     ishmemx_init_attr(attr);
   }
 }
 
 /// Update signal address with signal using signal operation
-/// \param [out] sig_addr Address of the signal to be updated
-/// \param [in] signal Value of the signal to update
-/// \param [in] sig_op Operator used in updating signal address
-/// \param [in] PE Processing element
-void signal_op(uint64_t *sig_addr, uint64_t signal, int sig_op, int PE) {
+/// \param [out] sig_addr Symmetric address of the signal data object to be
+/// updated on the remote PE.
+/// \param [in] signal Unsigned 64-bit value that is used for updating the
+/// remote sig_addr signal data object.
+/// \param [in] sig_op Operator used to update signal data object
+/// \param [in] pe Processing element
+void signal_op(uint64_t *sig_addr, uint64_t signal, int sig_op, int pe) {
   if (sig_op == ISHMEM_SIGNAL_SET) {
-    ishmemx_signal_set(sig_addr, signal, PE);
+    ishmemx_signal_set(sig_addr, signal, pe);
   } else if (sig_op == ISHMEM_SIGNAL_ADD) {
-    ishmemx_signal_add(sig_addr, signal, PE);
+    ishmemx_signal_add(sig_addr, signal, pe);
   } else {
     throw std::runtime_error("Unsupported signal operator!");
   }