From: Gabriel Corona <gabriel.corona@loria.fr>
Date: Mon, 14 Mar 2016 08:33:06 +0000 (+0100)
Subject: [mc] Fix documentation
X-Git-Tag: v3_13~428^2~3
X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/06dbadb52775807739d0a87b6a8b009be06f4d5f?ds=sidebyside

[mc] Fix documentation
---

diff --git a/src/mc/Variable.hpp b/src/mc/Variable.hpp
index a4f048a4d1..f3b8e0a4bb 100644
--- a/src/mc/Variable.hpp
+++ b/src/mc/Variable.hpp
@@ -27,15 +27,16 @@ public:
   unsigned type_id = 0;
   simgrid::mc::Type* type = nullptr;
 
-  /** Address of the variable -if it is fixed) */
+  /** Address of the variable (if it is fixed) */
   void* address = nullptr;
 
-  /** Description of the location of the variable if it's not fixed */
+  /** Description of the location of the variable (if it's not fixed) */
   simgrid::dwarf::LocationList location_list;
 
   /** Offset of validity of the variable (DW_AT_start_scope)
    *
-   *  This variable is not valid since the beginning of its scope.
+   *  This is an offset from the variable scope beginning. This variable
+   *  is only valid starting from this offset.
    */
   std::size_t start_scope = 0;