[doc] SMPI_app_instance_register: improve doxygen

[simgrid.git] / src / smpi / internals / smpi_deployment.cpp

diff --git a/src/smpi/internals/smpi_deployment.cpp b/src/smpi/internals/smpi_deployment.cpp
index f7eea95..9569f8a 100644 (file)
--- a/src/smpi/internals/smpi_deployment.cpp
+++ b/src/smpi/internals/smpi_deployment.cpp
@@ -44,7 +44,10 @@ extern int process_count; // How many processes have been allocated over all ins
  * @brief Registers a running instance of a MPI program.
  *
  * @param name the reference name of the function.
- * @param code the main mpi function (must have a int ..(int argc, char *argv[])) prototype
+ * @param code either the main mpi function
+ *             (must have a int ..(int argc, char *argv[]) prototype) or nullptr
+ *             (if the function deployment is managed somewhere else —
+ *              e.g., when deploying manually or using smpirun)
  * @param num_processes the size of the instance we want to deploy
  */
 void SMPI_app_instance_register(const char *name, xbt_main_func_t code, int num_processes)