Comment on a function whose behavior may be misleading...

diff --git a/src/msg/msg_host.c b/src/msg/msg_host.c
index 074ed17..1ef7d2a 100644 (file)
--- a/src/msg/msg_host.c
+++ b/src/msg/msg_host.c
@@ -207,6 +207,7 @@ msg_host_t *MSG_get_host_table(void)
 
 /** \ingroup m_host_management
  * \brief Return a dynar containing all the hosts declared at a given point of time
+ * \remark The host order in the returned array is generally different from the host creation/declaration order in the XML platform (we use a hash table internally)
  */
 xbt_dynar_t MSG_hosts_as_dynar(void) {
   xbt_lib_cursor_t cursor;

diff --git a/src/simdag/sd_workstation.c b/src/simdag/sd_workstation.c
index 5d08726..ece914b 100644 (file)
--- a/src/simdag/sd_workstation.c
+++ b/src/simdag/sd_workstation.c
@@ -79,8 +79,9 @@ SD_workstation_t SD_workstation_get_by_name(const char *name)
  * \brief Returns the workstation list
  *
  * Use SD_workstation_get_number() to know the array size.
- *
+ * 
  * \return an array of \ref SD_workstation_t containing all workstations
+ * \remark The workstation order in the returned array is generally different from the workstation creation/declaration order in the XML platform (we use a hash table internally).
  * \see SD_workstation_get_number()
  */
 const SD_workstation_t *SD_workstation_get_list(void)