X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/093776b9da6272771c04f848d9bd5ee28f5e06e3..c50e469ccac5b2b146bfb48b598142e7a2043e59:/docs/source/app_s4u.rst diff --git a/docs/source/app_s4u.rst b/docs/source/app_s4u.rst index 885a6a932d..fd8bc9ab29 100644 --- a/docs/source/app_s4u.rst +++ b/docs/source/app_s4u.rst @@ -138,10 +138,6 @@ provides many helper functions to simplify the code of actors. .. |API_s4u_Mutex| replace:: **Mutex** -.. THE EXAMPLES - -.. include:: ../../examples/s4u/README.rst - Activities ********** @@ -369,6 +365,10 @@ pointers (yet?). This means that it is currently impossible to destroy a mailbox or a link. You can still destroy an host (but probably shouldn't), using :cpp:func:`simgrid::s4u::Host::destroy`. +.. THE EXAMPLES + +.. include:: ../../examples/README.rst + C++ API Reference ***************** @@ -601,11 +601,37 @@ s4u::VirtualMachine :protected-members: :undoc-members: +C API Reference +*************** + +============== +Main functions +============== + +.. doxygenfunction:: simgrid_init +.. doxygenfunction:: simgrid_get_clock +.. doxygenfunction:: simgrid_load_deployment +.. doxygenfunction:: simgrid_load_platform +.. doxygenfunction:: simgrid_register_default +.. doxygenfunction:: simgrid_register_function +.. doxygenfunction:: simgrid_run + +================== +Condition Variable +================== + +See also the :ref:`C++ API `. + +.. doxygenfunction:: sg_cond_init +.. doxygenfunction:: sg_cond_notify_all +.. doxygenfunction:: sg_cond_notify_one +.. doxygenfunction:: sg_cond_wait +.. doxygenfunction:: sg_cond_wait_for Python API Reference ******************** -The Python API is generated with pybind11. It closely mimicks the C++ +The Python API is automatically generated with pybind11. It closely mimicks the C++ API, to which you should refer for more information. ==========