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
EXPAND_ONLY_PREDEF = NO
SKIP_FUNCTION_MACROS = NO
+QUIET=YES
+
PREDEFINED += \
__cplusplus \
DOXYGEN \
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)=
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)
.. 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)
.. 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()
#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.
#ifndef DOXYGEN
XBT_ATTRIB_DEPRECATED_v329("Please use set_host() instead") XBT_PUBLIC void migrate(Host* new_host);
#endif
-
-/** @} */
}
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;