improve the doc of MSG_host_on() and friends

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

diff --git a/src/msg/msg_host.c b/src/msg/msg_host.c
index 21d7ee2..f745ee8 100644 (file)
--- a/src/msg/msg_host.c
+++ b/src/msg/msg_host.c
@@ -120,16 +120,22 @@ msg_host_t MSG_host_self(void)
 }
 
 
-/*
+/** \ingroup m_host_management
+ *
  * \brief Start the host if it is off
+ *
+ * See also #MSG_host_is_on() and #MSG_host_is_off() to test the current state of the host and @ref SURF_plugin_energy for more info on DVFS.
  */
 void MSG_host_on(msg_host_t host)
 {
   simcall_host_on(host);
 }
 
-/*
+/** \ingroup m_host_management
+ *
  * \brief Stop the host if it is on
+ *
+ * See also #MSG_host_is_on() and #MSG_host_is_off() to test the current state of the host and @ref SURF_plugin_energy for more info on DVFS.
  */
 void MSG_host_off(msg_host_t host)
 {
@@ -307,9 +313,12 @@ void MSG_host_set_property_value(msg_host_t host, const char *name, char *value,
 }
 
 
-/** @ingroup msg_gos_functions
+/** @ingroup m_host_management
+ *
  * @brief Determine if a host is up and running.
  *
+ * See also #MSG_host_on() and #MSG_host_off() to switch the host ON and OFF and @ref SURF_plugin_energy for more info on DVFS.
+ *
  * @param host host to test
  * @return Returns true if the host is up and running, and false if it's currently down
  */
@@ -318,8 +327,11 @@ int MSG_host_is_on(msg_host_t host)
   xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
   return (simcall_host_get_state(host));
 }
-/** @ingroup msg_gos_functions
+/** @ingroup m_host_management
+ *
  * @brief Determine if a host is currently off.
+ *
+ * See also #MSG_host_on() and #MSG_host_off() to switch the host ON and OFF and @ref SURF_plugin_energy for more info on DVFS.
  */
 int MSG_host_is_off(msg_host_t host)
 {