From: Martin Quinson <martin.quinson@ens-rennes.fr>
Date: Thu, 2 Jan 2020 16:56:31 +0000 (+0100)
Subject: various doc small fixups
X-Git-Tag: v3.25~172
X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/16f7621cfa2a35bb56703231981adc1a8da00ca2

various doc small fixups
---

diff --git a/docs/source/Doxyfile b/docs/source/Doxyfile
index bdc96d604f..8b91326479 100644
--- a/docs/source/Doxyfile
+++ b/docs/source/Doxyfile
@@ -29,9 +29,11 @@ GENERATE_LATEX         = NO
 FULL_PATH_NAMES        = NO # Don't leak the path on which it was built
 XML_PROGRAMLISTING     = NO # No program listings, please
 CREATE_SUBDIRS         = NO # Mandatory for exhale
+AUTOLINK_SUPPORT       = NO # Don't try to link words that correspond to documented classes to their corresponding doc
 
 # Allow for rst directives and advanced functions e.g. grid tables
-ALIASES                = "beginrst=\verbatim embed:rst"
+ALIASES                = "beginrst=\verbatim embed:rst:leading-asterisk"
+ALIASES               += "rst=\verbatim "
 ALIASES               += "endrst=\endverbatim"
 
 # Enable preprocessing and related preprocessor necessities
@@ -40,6 +42,8 @@ MACRO_EXPANSION        = YES
 EXPAND_ONLY_PREDEF     = NO
 SKIP_FUNCTION_MACROS   = NO
 
+QUIET=YES
+
 PREDEFINED             += \
     __cplusplus \
     DOXYGEN \
@@ -55,5 +59,6 @@ PREDEFINED             += \
     XBT_PRIVATE= \
     XBT_ATTRIB_NORETURN= \
     XBT_ATTRIB_UNUSED= \
+    XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s,c,l)= \
     XBT_ATTRIB_DEPRECATED_v328(m)= \
     XBT_ATTRIB_DEPRECATED_v329(m)=
diff --git a/docs/source/_ext/autodoxy.py b/docs/source/_ext/autodoxy.py
index 0ee926041b..93569db95b 100644
--- a/docs/source/_ext/autodoxy.py
+++ b/docs/source/_ext/autodoxy.py
@@ -238,6 +238,7 @@ class DoxygenDocumenter(Documenter):
         directive = getattr(self, 'directivetype', self.objtype)
         name = self.format_name()
         sourcename = self.get_sourcename()
+        #print('.. %s:%s:: %s%s' % (domain, directive, name, sig))
         self.add_line(u'.. %s:%s:: %s%s' % (domain, directive, name, sig),
                       sourcename)
 
diff --git a/docs/source/app_s4u.rst b/docs/source/app_s4u.rst
index b4d2d3dead..e49d6501e8 100644
--- a/docs/source/app_s4u.rst
+++ b/docs/source/app_s4u.rst
@@ -430,8 +430,8 @@ Creating actors
       .. autodoxymethod:: sg_actor_init(const char *name, sg_host_t host)
       .. autodoxymethod:: sg_actor_start(sg_actor_t actor, xbt_main_func_t code, int argc, char **argv)
 
-      .. autodoxymethod:: ::sg_actor_attach(const char *name, void *data, sg_host_t host, xbt_dict_t properties)
-      .. autodoxymethod:: ::sg_actor_detach()
+      .. autodoxymethod:: sg_actor_attach(const char *name, void *data, sg_host_t host, xbt_dict_t properties)
+      .. autodoxymethod:: sg_actor_detach()
 
       .. autodoxymethod:: sg_actor_ref(sg_actor_t actor)
       .. autodoxymethod:: sg_actor_unref(sg_actor_t actor)
@@ -943,7 +943,7 @@ Synchronization Objects
 
       .. group-tab:: C++
 
-         .. autodoxymethod:: simgrid::s4u::Barrier::Barrier(unsigned int count)
+         .. autodoxymethod:: simgrid::s4u::Barrier::Barrier(unsigned int expected_actors)
          .. autodoxymethod:: simgrid::s4u::Barrier::create(unsigned int expected_actors)
          .. autodoxymethod:: simgrid::s4u::Barrier::wait()
 
diff --git a/include/simgrid/s4u/Actor.hpp b/include/simgrid/s4u/Actor.hpp
index 9d46edac88..84d61a9eab 100644
--- a/include/simgrid/s4u/Actor.hpp
+++ b/include/simgrid/s4u/Actor.hpp
@@ -84,9 +84,12 @@ public:
 #endif
 
   /** Signal indicating that an actor terminated its code.
+   *  @beginrst
    *  The actor may continue to exist if it is still referenced in the simulation, but it's not active anymore.
-   *  If you want to free extra data when the actor's destructor is called, use Actor::on_destruction.
-   *  If you want to register to the termination of a given actor, use this_actor::on_exit() instead.*/
+   *  If you want to free extra data when the actor's destructor is called, use :cpp:var:`Actor::on_destruction`.
+   *  If you want to register to the termination of a given actor, use :cpp:func:`this_actor::on_exit()` instead.
+   *  @endrst
+   */
   static xbt::signal<void(Actor const&)> on_termination;
   /** Signal indicating that an actor is about to disappear (its destructor was called).
    *  This signal is fired for any destructed actor, which is mostly useful when designing plugins and extensions.
@@ -373,8 +376,6 @@ XBT_PUBLIC void set_host(Host* new_host);
 #ifndef DOXYGEN
 XBT_ATTRIB_DEPRECATED_v329("Please use set_host() instead") XBT_PUBLIC void migrate(Host* new_host);
 #endif
-
-/** @} */
 }
 
 
diff --git a/include/simgrid/s4u/Barrier.hpp b/include/simgrid/s4u/Barrier.hpp
index dfc4a547a7..34c618291e 100644
--- a/include/simgrid/s4u/Barrier.hpp
+++ b/include/simgrid/s4u/Barrier.hpp
@@ -30,7 +30,7 @@ private:
 
 public:
   /** Creates a barrier for the given amount of actors */
-  explicit Barrier(unsigned int expected_processes) : expected_actors_(expected_processes) {}
+  explicit Barrier(unsigned int expected_actors) : expected_actors_(expected_actors) {}
 #ifndef DOXYGEN
   ~Barrier()              = default;
   Barrier(Barrier const&) = delete;