tiny doc improvement

[simgrid.git] / include / simgrid / simix.h

diff --git a/include/simgrid/simix.h b/include/simgrid/simix.h
index c17d7ec..1dac63b 100644 (file)
--- a/include/simgrid/simix.h
+++ b/include/simgrid/simix.h
@@ -46,11 +46,6 @@ typedef enum {
 } e_smx_state_t;
 /** @} */
 
-/* ******************************** Synchro ************************************ */
-
-/** @ingroup simix_synchro_management */
-typedef struct s_smx_sem_t* smx_sem_t;
-
 /* ****************************** Process *********************************** */
 
 typedef enum {
@@ -91,9 +86,6 @@ XBT_PUBLIC void SIMIX_set_maestro(void (*code)(void*), void* data);
 XBT_PUBLIC void SIMIX_run();
 XBT_PUBLIC double SIMIX_get_clock();
 
-/* Timer functions FIXME: should these be public? */
-typedef struct s_smx_timer_t* smx_timer_t;
-
 XBT_PUBLIC smx_timer_t SIMIX_timer_set(double date, void (*function)(void*), void* arg);
 XBT_PUBLIC void SIMIX_timer_remove(smx_timer_t timer);
 XBT_PUBLIC double SIMIX_timer_next();
@@ -122,9 +114,9 @@ XBT_PUBLIC void SIMIX_process_set_function(const char* process_host, const char*
 SG_END_DECL()
 
 #ifdef __cplusplus
-XBT_PUBLIC void SIMIX_function_register(std::string name, void (*code)(std::vector<std::string>));
-XBT_PUBLIC void SIMIX_function_register(std::string name, xbt_main_func_t code);
-XBT_PUBLIC void SIMIX_launch_application(std::string file);
+XBT_PUBLIC void SIMIX_function_register(const std::string& name, void (*code)(std::vector<std::string>));
+XBT_PUBLIC void SIMIX_function_register(const std::string& name, xbt_main_func_t code);
+XBT_PUBLIC void SIMIX_launch_application(const std::string& file);
 #endif
 
 /*********************************** Host *************************************/
@@ -165,7 +157,7 @@ XBT_PUBLIC void SIMIX_comm_set_copy_data_callback(void (*callback)(smx_activity_
 XBT_PUBLIC void SIMIX_comm_copy_pointer_callback(smx_activity_t comm, void* buff, size_t buff_size);
 XBT_PUBLIC void SIMIX_comm_copy_buffer_callback(smx_activity_t comm, void* buff, size_t buff_size);
 
-XBT_PUBLIC void SIMIX_comm_finish(smx_activity_t synchro);
+XBT_ATTRIB_DEPRECATED_v325("Please use CommImpl::finish") XBT_PUBLIC void SIMIX_comm_finish(smx_activity_t synchro);
 
 /******************************************************************************/
 /*                            SIMIX simcalls                                  */
@@ -176,9 +168,9 @@ XBT_PUBLIC void SIMIX_comm_finish(smx_activity_t synchro);
 
 /******************************* Host simcalls ********************************/
 #ifdef __cplusplus
-XBT_PUBLIC smx_activity_t simcall_execution_parallel_start(std::string name, int host_nb, sg_host_t* host_list,
-                                                           double* flops_amount, double* bytes_amount, double rate,
-                                                           double timeout);
+XBT_PUBLIC smx_activity_t simcall_execution_parallel_start(const std::string& name, int host_nb,
+                                                           const sg_host_t* host_list, const double* flops_amount,
+                                                           const double* bytes_amount, double rate, double timeout);
 #endif
 XBT_PUBLIC e_smx_state_t simcall_execution_wait(smx_activity_t execution);
 XBT_PUBLIC e_smx_state_t simcall_execution_test(smx_activity_t execution);
@@ -267,11 +259,12 @@ XBT_ATTRIB_DEPRECATED_v325("Please use Exec::set_priority()") XBT_PUBLIC
     void simcall_execution_set_priority(smx_activity_t execution, double priority);
 XBT_ATTRIB_DEPRECATED_v325("Please use Exec::set_bound()") XBT_PUBLIC
     void simcall_execution_set_bound(smx_activity_t execution, double bound);
+SG_END_DECL()
+
 #ifdef __cplusplus
 XBT_ATTRIB_DEPRECATED_v325("Please use Exec::start()") XBT_PUBLIC smx_activity_t
-    simcall_execution_start(std::string name, std::string category, double flops_amount, double priority, double bound,
-                            sg_host_t host);
+    simcall_execution_start(const std::string& name, const std::string& category, double flops_amount, double priority,
+                            double bound, sg_host_t host);
 #endif
-SG_END_DECL()
 
 #endif