From c17e2d0a40dd44817f3c8d5da7d72f4ef8f1e3c8 Mon Sep 17 00:00:00 2001 From: Martin Quinson Date: Tue, 14 May 2019 13:59:38 +0200 Subject: [PATCH] fix some errors and warnings in the doc generation --- docs/source/community.rst | 6 +++--- docs/source/platform_howtos.rst | 2 +- examples/s4u/README.rst | 4 ++-- include/simgrid/s4u/Comm.hpp | 2 ++ 4 files changed, 8 insertions(+), 6 deletions(-) diff --git a/docs/source/community.rst b/docs/source/community.rst index fe4daddf94..88d5a5f875 100644 --- a/docs/source/community.rst +++ b/docs/source/community.rst @@ -165,9 +165,9 @@ Futures and Promises """""""""""""""""""" - 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`). diff --git a/docs/source/platform_howtos.rst b/docs/source/platform_howtos.rst index 1c4eaca2dd..1ac6c4bcbc 100644 --- a/docs/source/platform_howtos.rst +++ b/docs/source/platform_howtos.rst @@ -61,7 +61,7 @@ freely available, though. .. _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 diff --git a/examples/s4u/README.rst b/examples/s4u/README.rst index f751c6bc14..5adf1d329c 100644 --- a/examples/s4u/README.rst +++ b/examples/s4u/README.rst @@ -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. - - **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. - |br| `examples/s4u/mc-failed-assert/s4u-mc-failed-assert.cpp `_ + |br| `examples/s4u/mc-failing-assert/s4u-mc-failing-assert.cpp `_ .. |br| raw:: html diff --git a/include/simgrid/s4u/Comm.hpp b/include/simgrid/s4u/Comm.hpp index d82a019e77..467dd88971 100644 --- a/include/simgrid/s4u/Comm.hpp +++ b/include/simgrid/s4u/Comm.hpp @@ -39,9 +39,11 @@ class XBT_PUBLIC Comm : public Activity { 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 +#endif virtual ~Comm(); -- 2.20.1