added tesh tests for DVFS

[simgrid.git] / src / msg / msg_host.c

diff --git a/src/msg/msg_host.c b/src/msg/msg_host.c
index 76df233..6e1e568 100644 (file)
--- a/src/msg/msg_host.c
+++ b/src/msg/msg_host.c
@@ -264,27 +264,33 @@ int MSG_host_is_avail(msg_host_t host)
   return (simcall_host_get_state(host));
 }
 
-/**
- * \ingroup msg_gos_functions
+/** \ingroup m_host_management
+ * \brief Return the speed of the processor (in flop/s) at a given pstate
  *
+ * \param  host host to test
+ * \param pstate_index pstate to test
+ * \return Returns the processor speed associated with pstate_index
  */
 double MSG_get_host_power_peak_at(msg_host_t host, int pstate_index) {
          xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
          return (simcall_host_get_power_peak_at(host, pstate_index));
 }
 
-/**
- * \ingroup msg_gos_functions
+/** \ingroup m_host_management
+ * \brief Return the current speed of the processor (in flop/s)
  *
+ * \param  host host to test
+ * \return Returns the current processor speed
  */
 double MSG_get_host_current_power_peak(msg_host_t host) {
          xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
          return simcall_host_get_current_power_peak(host);
 }
 
-/**
- * \ingroup msg_gos_functions
+/** \ingroup m_host_management
+ * \brief Return the number of pstates defined for a host
  *
+ * \param  host host to test
  */
 int MSG_get_host_nb_pstates(msg_host_t host) {
 
@@ -292,9 +298,11 @@ int MSG_get_host_nb_pstates(msg_host_t host) {
          return (simcall_host_get_nb_pstates(host));
 }
 
-/**
- * \ingroup msg_gos_functions
+/** \ingroup m_host_management
+ * \brief Sets the speed of the processor (in flop/s) at a given pstate
  *
+ * \param  host host to test
+ * \param pstate_index pstate to switch to
  */
 void MSG_set_host_power_peak_at(msg_host_t host, int pstate_index) {
          xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
@@ -302,9 +310,11 @@ void MSG_set_host_power_peak_at(msg_host_t host, int pstate_index) {
          simcall_host_set_power_peak_at(host, pstate_index);
 }
 
-/**
- * \ingroup msg_gos_functions
+/** \ingroup m_host_management
+ * \brief Return the total energy consumed by a host (in Joules)
  *
+ * \param  host host to test
+ * \return Returns the consumed energy
  */
 double MSG_get_host_consumed_energy(msg_host_t host) {
          xbt_assert((host != NULL), "Invalid parameters (host is NULL)");