[DVFS] Update HostDvfs class documentation

diff --git a/src/surf/plugins/host_dvfs.cpp b/src/surf/plugins/host_dvfs.cpp
index 5d518c7..5ff2dcb 100644 (file)
--- a/src/surf/plugins/host_dvfs.cpp
+++ b/src/surf/plugins/host_dvfs.cpp
@@ -143,6 +143,24 @@ public:
   }
 };
 
+/**
+ *  Add this to your host tag:
+ *    - <prop id="plugin/dvfs/governor" value="performance" />
+ *
+ *  Valid values as of now are: performance, powersave, ondemand, conservative
+ *  It doesn't matter if you use uppercase or lowercase.
+ *
+ *  For the sampling rate, use this:
+ *
+ *    - <prop id="plugin/dvfs/sampling_rate" value="2" />
+ *
+ *  This will run the update() method of the specified governor every 2 seconds
+ *  on that host.
+ *
+ *  These properties can also be used within the <config> tag to configure
+ *  these values globally. Using them within the <host> will overwrite this
+ *  global configuration
+ */
 class HostDvfs {
 public:
   static simgrid::xbt::Extension<simgrid::s4u::Host, HostDvfs> EXTENSION_ID;