X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/93c7b4bd9208b45b5a5899abd1da65262431c33f..34d4ea3aa3fbfab92b7fde639f236f03c9d3fb20:/include/simgrid/plugins/load.h

diff --git a/include/simgrid/plugins/load.h b/include/simgrid/plugins/load.h
index a9fa55af5b..75f3019add 100644
--- a/include/simgrid/plugins/load.h
+++ b/include/simgrid/plugins/load.h
@@ -1,4 +1,4 @@
-/* Copyright (c) 2017-2018. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2017-2019. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
@@ -20,6 +20,10 @@ XBT_PUBLIC double sg_host_get_computed_flops(sg_host_t host);
 XBT_PUBLIC void sg_host_load_reset(sg_host_t host);
 
 #define MSG_host_load_plugin_init() sg_host_load_plugin_init()
+/** @brief Returns the current load of that host, as a ratio = achieved_flops / (core_current_speed * core_amount)
+ *
+ *  See simgrid::plugin::HostLoad::get_current_load() for the full documentation.
+ */
 #define MSG_host_get_current_load(host) sg_host_get_current_load(host)
 #define MSG_host_get_computed_flops(host) sg_host_get_computed_flops(host)
 #define MSG_host_get_avg_load(host) sg_host_get_avg_load(host)