From: Martin Quinson <martin.quinson@loria.fr>
Date: Tue, 7 Aug 2018 10:21:28 +0000 (+0200)
Subject: documentation cleanups
X-Git-Tag: v3_21~275
X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/35c7d3b0f6250d3762c396c88833f61c03412747

documentation cleanups
---

diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in
index e3c1d9fc41..b5f7607ac5 100644
--- a/doc/Doxyfile.in
+++ b/doc/Doxyfile.in
@@ -686,6 +686,7 @@ INPUT                  = @CMAKE_HOME_DIRECTORY@/doc/doxygen/index.doc \
                          @CMAKE_HOME_DIRECTORY@/doc/doxygen/module-trace.doc \
                          @CMAKE_BINARY_DIR@/doc/doxygen/logcategories.doc \
                          @CMAKE_HOME_DIRECTORY@/include/ \
+			 @CMAKE_HOME_DIRECTORY@/src/plugins/ \
                          @CMAKE_HOME_DIRECTORY@/examples/msg/README.doc \
                          @CMAKE_HOME_DIRECTORY@/examples/s4u/README.doc
 
@@ -1458,6 +1459,7 @@ PREDEFINED             = __cplusplus \
                          XBT_PUBLIC_DATA=extern \
 			 XBT_PUBLIC= \
                          XBT_INLINE= \
+			 XBT_ALWAYS_INLINE= \
 			 XBT_PRIVATE= \
 			 XBT_ATTRIB_NORETURN= \
 			 XBT_ATTRIB_UNUSED= \
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 9b50a14aeb..0be8937cbc 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -24,7 +24,6 @@ Welcome to SimGrid's documentation!
    :caption: API Reference:
 
 	     API <api/library_root.rst>
-	     S4U <api/s4u.rst>
 
 Indices and tables
 ==================
diff --git a/examples/msg/README.doc b/examples/msg/README.doc
index 203c2495d2..53ea4d7f2a 100644
--- a/examples/msg/README.doc
+++ b/examples/msg/README.doc
@@ -1,5 +1,5 @@
-This file follows the Doxygen syntax to be included in the
-documentation, but it should remain readable directly.
+// This file follows the Doxygen syntax to be included in the
+// documentation, but it should remain readable directly.
 
 /** 
  @defgroup msg_examples MSG examples
@@ -114,12 +114,12 @@ TODO: show the XML files instead if it's what is interesting. On a "XML example
 
 */
 
-As a human, you can stop reading at this point. The rest is garbage:
-
-Every example must be listed in the following, but it's not possible
-to move this content upper as each @example directive seems to eat
-everything until the next */ marker (and the content is placed at the
-top of the example file). 
+// As a human, you can stop reading at this point. The rest is garbage:
+// 
+// Every example must be listed in the following, but it's not possible
+// to move this content upper as each @example directive seems to eat
+// everything until the next */ marker (and the content is placed at the
+// top of the example file). 
 
 
 /**
diff --git a/examples/s4u/README.doc b/examples/s4u/README.doc
index 179d3252d2..3d564cadff 100644
--- a/examples/s4u/README.doc
+++ b/examples/s4u/README.doc
@@ -1,12 +1,12 @@
-S4U (Simgrid for you) is the next interface of SimGrid, expected to be released with SimGrid 4.0.
-
-Even if it is not completely rock stable yet, it may well already fit
-your needs. You are welcome to try it and report any interface
-glitches that you see. Be however warned that the interface may change
-until the final release.  You will have to adapt your code on the way.
-
-This file follows the Doxygen syntax to be included in the
-documentation, but it should remain readable directly.
+// S4U (Simgrid for you) is the next interface of SimGrid, expected to be released with SimGrid 4.0.
+//
+// Even if it is not completely rock stable yet, it may well already fit
+// your needs. You are welcome to try it and report any interface
+// glitches that you see. Be however warned that the interface may change
+// until the final release.  You will have to adapt your code on the way.
+// 
+// This file follows the Doxygen syntax to be included in the
+// documentation, but it should remain readable directly.
 
 /** 
  @defgroup s4u_examples S4U examples