Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
fix some errors and warnings in the doc generation
authorMartin Quinson <martin.quinson@ens-rennes.fr>
Tue, 14 May 2019 11:59:38 +0000 (13:59 +0200)
committerMartin Quinson <martin.quinson@ens-rennes.fr>
Tue, 14 May 2019 11:59:48 +0000 (13:59 +0200)
docs/source/community.rst
docs/source/platform_howtos.rst
examples/s4u/README.rst
include/simgrid/s4u/Comm.hpp

index fe4dadd..88d5a5f 100644 (file)
@@ -165,9 +165,9 @@ Futures and Promises
 """"""""""""""""""""
 
  - Some features are missing in the Maestro future implementation
 """"""""""""""""""""
 
  - Some features are missing in the Maestro future implementation
-  (`simgrid::kernel::Future`, `simgrid::kernel::Promise`)
-  could be extended to support additional features:
-  `when_any`, `shared_future`, etc.
+   (`simgrid::kernel::Future`, `simgrid::kernel::Promise`)
+   could be extended to support additional features:
+   `when_any`, `shared_future`, etc.
 
  - The corresponding feature might then be implemented in the user process
    futures (`simgrid::simix::Future`).
 
  - The corresponding feature might then be implemented in the user process
    futures (`simgrid::simix::Future`).
index 1c4eaca..1ac6c4b 100644 (file)
@@ -61,7 +61,7 @@ freely available, though.
 .. _howto_churn:
 
 Modeling Churn (e.g., in P2P)
 .. _howto_churn:
 
 Modeling Churn (e.g., in P2P)
-****************************
+*****************************
 
 One of the biggest challenges in P2P settings is to cope with the
 churn, meaning that resources keep appearing and disappearing. In
 
 One of the biggest challenges in P2P settings is to cope with the
 churn, meaning that resources keep appearing and disappearing. In
index f751c6b..5adf1d3 100644 (file)
@@ -418,12 +418,12 @@ mode is rather experimental in SimGrid (as of v3.22). You should not
 enable it unless you really want to formally verify your applications:
 SimGrid is slower and maybe less robust when MC is enabled.
 
 enable it unless you really want to formally verify your applications:
 SimGrid is slower and maybe less robust when MC is enabled.
 
-  - **Failed assert**
+  - **Failing assert**
     In this example, two actors send some data to a central server,
     which asserts that the messages are always received in the same order.
     This is obviously wrong, and the model-checker correctly finds a
     counter-example to that assertion.
     In this example, two actors send some data to a central server,
     which asserts that the messages are always received in the same order.
     This is obviously wrong, and the model-checker correctly finds a
     counter-example to that assertion.
-    |br| `examples/s4u/mc-failed-assert/s4u-mc-failed-assert.cpp <https://framagit.org/simgrid/simgrid/tree/master/examples/s4u/mc-failed-assert/s4u-mc-failed-assert.cpp>`_
+    |br| `examples/s4u/mc-failing-assert/s4u-mc-failing-assert.cpp <https://framagit.org/simgrid/simgrid/tree/master/examples/s4u/mc-failing-assert/s4u-mc-failing-assert.cpp>`_
 
 .. |br| raw:: html
 
 
 .. |br| raw:: html
 
index d82a019..467dd88 100644 (file)
@@ -39,9 +39,11 @@ class XBT_PUBLIC Comm : public Activity {
   Comm() : Activity() {}
 
 public:
   Comm() : Activity() {}
 
 public:
+#ifndef DOXYGEN
   friend XBT_PUBLIC void intrusive_ptr_release(Comm* c);
   friend XBT_PUBLIC void intrusive_ptr_add_ref(Comm* c);
   friend Mailbox; // Factory of comms
   friend XBT_PUBLIC void intrusive_ptr_release(Comm* c);
   friend XBT_PUBLIC void intrusive_ptr_add_ref(Comm* c);
   friend Mailbox; // Factory of comms
+#endif
 
   virtual ~Comm();
 
 
   virtual ~Comm();