From: Gabriel Corona <gabriel.corona@loria.fr>
Date: Wed, 14 Oct 2015 08:06:13 +0000 (+0200)
Subject: [mc] Documentation
X-Git-Tag: v3_13~1644^2~55
X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/bd38fea6c9ed9ac4d381cbbfee938776553147fd

[mc] Documentation
---

diff --git a/src/mc/RegionSnapshot.hpp b/src/mc/RegionSnapshot.hpp
index e54516a157..9b741303ad 100644
--- a/src/mc/RegionSnapshot.hpp
+++ b/src/mc/RegionSnapshot.hpp
@@ -12,8 +12,8 @@
 
 #include <xbt/base.h>
 
-#include "PageStore.hpp"
-#include "AddressSpace.hpp"
+#include <mc/PageStore.hpp>
+#include <mc/AddressSpace.hpp>
 
 namespace simgrid {
 namespace mc {
@@ -118,21 +118,25 @@ public:
   void operator()(void* p) const;
 };
 
-/** @brief Copy/snapshot of a given memory region
+typedef std::unique_ptr<char[], data_deleter> unique_data_ptr;
+
+/** A copy/snapshot of a given memory region
  *
  *  Different types of region snapshot storage types exist:
- *  <ul>
- *    <li>flat/dense snapshots are a simple copy of the region;</li>
- *    <li>sparse/per-page snapshots are snaapshots which shared
- *    identical pages.</li>
- *    <li>privatized (SMPI global variable privatisation).
- *  </ul>
+ *
+ *  * flat/dense snapshots are a simple copy of the region;
+ *
+ *  * sparse/per-page snapshots are snaapshots which shared
+ *    identical pages.
+ *
+ *  * privatized (SMPI global variable privatisation).
  *
  *  This is handled with a variant based approch:
  *
- *    * `storage_type` identified the type of storage;
- *    * an anonymous enum is used to distinguish the relevant types for
- *      each type.
+ *  * `storage_type` identified the type of storage;
+ *
+ *  * an anonymous enum is used to distinguish the relevant types for
+ *    each type.
  */
 class RegionSnapshot {
 public:
@@ -144,7 +148,7 @@ public:
   static const StorageType ChunkedData = StorageType::Chunked;
   static const StorageType PrivatizedData = StorageType::Privatized;
 public:
-  typedef std::unique_ptr<char[], data_deleter> flat_data_ptr;
+  typedef unique_data_ptr flat_data_ptr;
 private:
   RegionType region_type_;
   StorageType storage_type_;
diff --git a/src/mc/Type.hpp b/src/mc/Type.hpp
index 2c2d8171d7..accea5688e 100644
--- a/src/mc/Type.hpp
+++ b/src/mc/Type.hpp
@@ -18,7 +18,10 @@
 namespace simgrid {
 namespace mc {
 
-/** Represent a member of  a structure (or inheritance) */
+/** A member of a structure, union
+ *
+ *  Inheritance is seen as a special member as well.
+ */
 class Member {
 public:
   Member() : inheritance(false), byte_size(0), type_id(0) {}
@@ -52,10 +55,7 @@ public:
   }
 };
 
-/** Represents a type in the program
- *
- *  It is currently used to represent members of structs and unions as well.
- */
+/** A type in the model-checked program */
 class Type {
 public:
   Type();
diff --git a/src/mc/Variable.hpp b/src/mc/Variable.hpp
index 9b57dbcb9d..804a7a726a 100644
--- a/src/mc/Variable.hpp
+++ b/src/mc/Variable.hpp
@@ -17,6 +17,7 @@
 namespace simgrid {
 namespace mc {
 
+/** A variable (global or local) in the model-checked program */
 class Variable {
 public:
   Variable();