From 0bb8c9c44cfc43c454d115b38235c2a9348dd2ad Mon Sep 17 00:00:00 2001
From: Martin Quinson <martin.quinson@loria.fr>
Date: Mon, 6 Aug 2018 23:52:11 +0200
Subject: [PATCH] various doc fixes

---
 examples/s4u/README.doc     |  7 ++++---
 src/mc/sosp/PageStore.cpp   |  5 ++---
 src/mc/sosp/mc_snapshot.cpp | 11 +++++------
 src/simix/libsmx.cpp        |  3 ++-
 4 files changed, 13 insertions(+), 13 deletions(-)

diff --git a/examples/s4u/README.doc b/examples/s4u/README.doc
index da38da535c..179d3252d2 100644
--- a/examples/s4u/README.doc
+++ b/examples/s4u/README.doc
@@ -286,8 +286,8 @@ than the previous examples.
     Shows how to implement a classical communication pattern, where a token is exchanged along a ring to reach every
     participant.
 
-  - <b>Master Workers:</b> @ref examples/s4u/app-masterworker/s4u-app-masterworkers-class.cpp 
-                           @ref examples/s4u/app-masterworker/s4u-app-masterworkers-fun.cpp @n
+  - <b>Master Workers:</b> @ref examples/s4u/app-masterworkers/s4u-app-masterworkers-class.cpp 
+                           @ref examples/s4u/app-masterworkers/s4u-app-masterworkers-fun.cpp @n
     Another good old example, where one Master process has a bunch of task to dispatch to a set of several Worker 
     processes. This example comes in two equivalent variants, one
     where the actors are specified as simple functions (which is easier to
@@ -329,7 +329,8 @@ than the previous examples.
 @example examples/s4u/async-waitany/s4u-async-waitany.cpp
 @example examples/s4u/app-bittorrent/s4u-bittorrent.cpp
 @example examples/s4u/app-chainsend/s4u-app-chainsend.cpp
-@example examples/s4u/app-masterworker/s4u-app-masterworker.cpp
+@example examples/s4u/app-masterworkers/s4u-app-masterworkers-class.cpp
+@example examples/s4u/app-masterworkers/s4u-app-masterworkers-fun.cpp
 @example examples/s4u/app-pingpong/s4u-app-pingpong.cpp
 @example examples/s4u/app-token-ring/s4u-app-token-ring.cpp
 @example examples/s4u/dht-chord/s4u-dht-chord.cpp
diff --git a/src/mc/sosp/PageStore.cpp b/src/mc/sosp/PageStore.cpp
index f0191c4889..e9a7fc16aa 100644
--- a/src/mc/sosp/PageStore.cpp
+++ b/src/mc/sosp/PageStore.cpp
@@ -1,5 +1,4 @@
-/* Copyright (c) 2015-2018. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2015-2018. 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. */
@@ -49,7 +48,7 @@ static XBT_ALWAYS_INLINE PageStore::hash_type mc_hash_page(const void* data)
 
 // ***** snapshot_page_manager
 
-PageStore::PageStore(size_t size) : memory_(nullptr), capacity_(size), top_index_(0)
+PageStore::PageStore(std::size_t size) : memory_(nullptr), capacity_(size), top_index_(0)
 {
   // Using mmap in order to be able to expand the region by relocating it somewhere else in the virtual memory space:
   void* memory =
diff --git a/src/mc/sosp/mc_snapshot.cpp b/src/mc/sosp/mc_snapshot.cpp
index a17e3fa974..68e80aa6dc 100644
--- a/src/mc/sosp/mc_snapshot.cpp
+++ b/src/mc/sosp/mc_snapshot.cpp
@@ -23,8 +23,7 @@
  *
  *  @param addr     Pointer
  *  @param snapshot Snapshot
- *  @param Snapshot region in the snapshot this pointer belongs to
- *         (or nullptr if it does not belong to any snapshot region)
+ *  @param process_index rank requesting the region
  * */
 mc_mem_region_t mc_get_snapshot_region(const void* addr, const simgrid::mc::Snapshot* snapshot, int process_index)
 {
@@ -102,11 +101,11 @@ const void* MC_region_read_fragmented(mc_mem_region_t region, void* target, cons
 /** Compare memory between snapshots (with known regions)
  *
  * @param addr1 Address in the first snapshot
- * @param snapshot2 Region of the address in the first snapshot
+ * @param region1 Region of the address in the first snapshot
  * @param addr2 Address in the second snapshot
- * @param snapshot2 Region of the address in the second snapshot
- * @return same as memcmp
- * */
+ * @param region2 Region of the address in the second snapshot
+ * @return same semantic as memcmp
+ */
 int MC_snapshot_region_memcmp(const void* addr1, mc_mem_region_t region1, const void* addr2, mc_mem_region_t region2,
                               size_t size)
 {
diff --git a/src/simix/libsmx.cpp b/src/simix/libsmx.cpp
index 68badd050e..d3409086df 100644
--- a/src/simix/libsmx.cpp
+++ b/src/simix/libsmx.cpp
@@ -34,9 +34,10 @@ XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix);
  * to create the SIMIX synchro. It can raise a host_error exception if the host crashed.
  *
  * @param name Name of the execution synchro to create
+ * @param category Tracing category
  * @param flops_amount amount Computation amount (in flops)
  * @param priority computation priority
- * @param bound
+ * @param bound Maximal speed for this execution (in flops) or -1 if no limit
  * @param host host where the synchro will be executed
  * @return A new SIMIX execution synchronization
  */
-- 
2.20.1