From 8d6b708655db62dcba942a12f2621e9bf2815351 Mon Sep 17 00:00:00 2001 From: Arnaud Legrand Date: Wed, 1 Jul 2015 09:05:09 +0200 Subject: [PATCH] Comment on a function whose behavior may be misleading... --- src/msg/msg_host.c | 1 + src/simdag/sd_workstation.c | 3 ++- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/src/msg/msg_host.c b/src/msg/msg_host.c index 074ed17fd4..1ef7d2a3ce 100644 --- 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 5d0872616d..ece914bce8 100644 --- 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) -- 2.20.1