From 9cc0d42f835e6aa5ea5195a346098e74b0376927 Mon Sep 17 00:00:00 2001
From: Gabriel Corona <gabriel.corona@loria.fr>
Date: Fri, 8 Apr 2016 11:22:05 +0200
Subject: [PATCH] [mc] Misc. comments

---
 src/mc/Channel.hpp                         | 5 +++++
 src/mc/Client.hpp                          | 4 ++++
 src/mc/CommunicationDeterminismChecker.cpp | 2 --
 src/mc/mc_base.h                           | 2 +-
 src/mc/mc_smx.cpp                          | 2 +-
 5 files changed, 11 insertions(+), 4 deletions(-)

diff --git a/src/mc/Channel.hpp b/src/mc/Channel.hpp
index 61514adc36..5ede34f106 100644
--- a/src/mc/Channel.hpp
+++ b/src/mc/Channel.hpp
@@ -16,6 +16,11 @@
 namespace simgrid {
 namespace mc {
 
+/** A channel for exchanging messages between model-checker and model-checked
+ *
+ *  This hides the way the messages are transfered. Currently, they are sent
+ *  over a SOCK_DGRAM socket.
+ */
 class Channel {
   int socket_ = -1;
   template<class M>
diff --git a/src/mc/Client.hpp b/src/mc/Client.hpp
index b4f95caa90..36a6578c83 100644
--- a/src/mc/Client.hpp
+++ b/src/mc/Client.hpp
@@ -22,6 +22,10 @@
 namespace simgrid {
 namespace mc {
 
+/** Model-checked-side of the communication protocol
+ *
+ *  Send messages to the model-checker and handles message from it.
+ */
 class XBT_PUBLIC() Client {
 private:
   bool active_ = false;
diff --git a/src/mc/CommunicationDeterminismChecker.cpp b/src/mc/CommunicationDeterminismChecker.cpp
index 86b26cc83a..4588869070 100644
--- a/src/mc/CommunicationDeterminismChecker.cpp
+++ b/src/mc/CommunicationDeterminismChecker.cpp
@@ -301,7 +301,6 @@ CommunicationDeterminismChecker::~CommunicationDeterminismChecker()
 
 }
 
-// TODO, deduplicate with SafetyChecker
 RecordTrace CommunicationDeterminismChecker::getRecordTrace() // override
 {
   RecordTrace res;
@@ -310,7 +309,6 @@ RecordTrace CommunicationDeterminismChecker::getRecordTrace() // override
   return res;
 }
 
-// TODO, deduplicate with SafetyChecker
 std::vector<std::string> CommunicationDeterminismChecker::getTextualTrace() // override
 {
   std::vector<std::string> trace;
diff --git a/src/mc/mc_base.h b/src/mc/mc_base.h
index 516b0ff0ce..fc587fb6b9 100644
--- a/src/mc/mc_base.h
+++ b/src/mc/mc_base.h
@@ -15,7 +15,7 @@
 namespace simgrid {
 namespace mc {
 
-/** Can this requests can be executed.
+/** Can this requests can be executed?
  *
  *  Most requests are always enabled but WAIT and WAITANY
  *  are not always enabled: a WAIT where the communication does not
diff --git a/src/mc/mc_smx.cpp b/src/mc/mc_smx.cpp
index d17f2b08fd..4a282241e4 100644
--- a/src/mc/mc_smx.cpp
+++ b/src/mc/mc_smx.cpp
@@ -164,7 +164,7 @@ const char* MC_smx_process_get_host_name(smx_process_t p)
 
   simgrid::mc::Process* process = &mc_model_checker->process();
 
-  /* Horrible hack to find the offset of the id in the simgrid::s4u::Host.
+  /* HACK, Horrible hack to find the offset of the id in the simgrid::s4u::Host.
 
      Offsetof is not supported for non-POD types but this should
      work in pratice for the targets currently supported by the MC
-- 
2.20.1