From: Martin Quinson Date: Thu, 19 Dec 2019 22:14:17 +0000 (+0100) Subject: reorder elements in the API ref guide X-Git-Tag: v3.25~253 X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/c0cea2ea6039711a50e3379bc7d071730a712eb5 reorder elements in the API ref guide --- diff --git a/docs/source/app_s4u.rst b/docs/source/app_s4u.rst index 134cb57e52..dcad90bfb2 100644 --- a/docs/source/app_s4u.rst +++ b/docs/source/app_s4u.rst @@ -376,55 +376,18 @@ shouldn't), using :cpp:func:`simgrid::s4u::Host::destroy`. API Reference ************* -.. _API_s4u_this_actor: - -================================== -Interacting with the current actor -================================== - -Static methods working on the current actor (see :ref:`API_s4u_Actor`). +.. _API_s4u_simulation_object: -.. doxygennamespace:: simgrid::s4u::this_actor +================== +Simulation objects +================== -.. _API_s4u_Activity: +.. _API_s4u_Actor: ============== -class Activity +⁣  class Actor ============== -.. autodoxyclass:: simgrid::s4u::Activity - - **Known subclasses:** - :ref:`Communications ` (started on Mailboxes and consuming links), - :ref:`Executions ` (started on Host and consuming CPU resources) - :ref:`I/O ` (started on and consumming disks). - See also the :ref:`section on activities ` above. - -Querying info about activities ------------------------------- - - .. autodoxymethod:: simgrid::s4u::Activity::get_remaining() - .. autodoxymethod:: simgrid::s4u::Activity::get_state() - .. autodoxymethod:: simgrid::s4u::Activity::set_remaining(double remains) - .. autodoxymethod:: simgrid::s4u::Activity::get_impl - -Activities lifecycle --------------------- - - .. autodoxymethod:: simgrid::s4u::Activity::start - .. autodoxymethod:: simgrid::s4u::Activity::cancel - .. autodoxymethod:: simgrid::s4u::Activity::test - .. autodoxymethod:: simgrid::s4u::Activity::wait - .. autodoxymethod:: simgrid::s4u::Activity::wait_for - .. autodoxymethod:: simgrid::s4u::Activity::wait_until(double time_limit) - - -.. _API_s4u_Actor: - -=========== -class Actor -=========== - .. doxygentypedef:: ActorPtr .. doxygentypedef:: aid_t @@ -562,82 +525,156 @@ Signals .. autodoxyvar:: simgrid::s4u::Actor::on_resume .. autodoxyvar:: simgrid::s4u::Actor::on_sleep .. autodoxyvar:: simgrid::s4u::Actor::on_wake_up - .. autodoxyvar:: simgrid::s4u::Actor::on_host_change .. autodoxyvar:: simgrid::s4u::Actor::on_termination .. autodoxyvar:: simgrid::s4u::Actor::on_destruction -.. _API_s4u_Barrier: +.. _API_s4u_this_actor: -============= -class Barrier -============= +==================== +⁣  The current actor +==================== -.. doxygentypedef:: BarrierPtr +Static methods working on the current actor (see :ref:`API_s4u_Actor`). -.. autodoxyclass:: simgrid::s4u::Barrier +.. doxygennamespace:: simgrid::s4u::this_actor - .. tabs:: +.. _API_s4u_Engine: - .. group-tab:: C++ +==================== +⁣  Simulation Engine +==================== - .. autodoxymethod:: simgrid::s4u::Barrier::Barrier(unsigned int count) - .. autodoxymethod:: simgrid::s4u::Barrier::create(unsigned int expected_actors) - .. autodoxymethod:: simgrid::s4u::Barrier::wait() +.. doxygenclass:: simgrid::s4u::Engine + :members: + :protected-members: + :undoc-members: + +.. _API_s4u_Mailbox: +================ +⁣  class Mailbox +================ -.. _API_s4u_Comm: +Please also refer to the :ref:`full doc on s4u::Mailbox `. + +.. doxygenclass:: simgrid::s4u::Mailbox + :members: + :protected-members: + :undoc-members: +.. _API_s4u_Resource: ========= -s4u::Comm +Resources ========= -.. doxygentypedef:: CommPtr +.. _API_s4u_Disk: -.. doxygenclass:: simgrid::s4u::Comm +============= +⁣  class Disk +============= + +.. doxygenclass:: simgrid::s4u::Disk :members: :protected-members: :undoc-members: -.. _API_s4u_ConditionVariable: -====================== -s4u::ConditionVariable -====================== -.. doxygentypedef:: ConditionVariablePtr +.. _API_s4u_Host: -.. doxygenclass:: simgrid::s4u::ConditionVariable +============= +⁣  class Host +============= + +.. doxygenclass:: simgrid::s4u::Host :members: :protected-members: :undoc-members: -.. _API_s4u_Disk: +.. _API_s4u_Link: -============ -s4u::Disk -============ +============= +⁣  class Link +============= -.. doxygenclass:: simgrid::s4u::Disk +.. doxygenclass:: simgrid::s4u::Link :members: :protected-members: :undoc-members: -.. _API_s4u_Engine: +.. _API_s4u_NetZone: -=========== -s4u::Engine -=========== +================ +⁣  class NetZone +================ -.. doxygenclass:: simgrid::s4u::Engine +.. doxygenclass:: simgrid::s4u::NetZone + :members: + :protected-members: + :undoc-members: + +.. _API_s4u_VirtualMachine: + +======================= +⁣  class VirtualMachine +======================= + +.. doxygenclass:: simgrid::s4u::VirtualMachine + :members: + :protected-members: + :undoc-members: + + +.. _API_s4u_Activity: + +============== +class Activity +============== + +.. autodoxyclass:: simgrid::s4u::Activity + + **Known subclasses:** + :ref:`Communications ` (started on Mailboxes and consuming links), + :ref:`Executions ` (started on Host and consuming CPU resources) + :ref:`I/O ` (started on and consumming disks). + See also the :ref:`section on activities ` above. + +Querying info about activities +------------------------------ + + .. autodoxymethod:: simgrid::s4u::Activity::get_remaining() + .. autodoxymethod:: simgrid::s4u::Activity::get_state() + .. autodoxymethod:: simgrid::s4u::Activity::set_remaining(double remains) + .. autodoxymethod:: simgrid::s4u::Activity::get_impl + +Activities lifecycle +-------------------- + + .. autodoxymethod:: simgrid::s4u::Activity::start + .. autodoxymethod:: simgrid::s4u::Activity::cancel + .. autodoxymethod:: simgrid::s4u::Activity::test + .. autodoxymethod:: simgrid::s4u::Activity::wait + .. autodoxymethod:: simgrid::s4u::Activity::wait_for + .. autodoxymethod:: simgrid::s4u::Activity::wait_until(double time_limit) + +.. _API_s4u_Comm: + +============= +⁣  class Comm +============= + +.. doxygentypedef:: CommPtr + +.. doxygenclass:: simgrid::s4u::Comm :members: :protected-members: :undoc-members: .. _API_s4u_Exec: -========= -s4u::Exec -========= +============= +⁣  class Exec +============= .. doxygentypedef:: ExecPtr @@ -648,9 +685,9 @@ s4u::Exec .. _API_s4u_ExecSeq: -============ -s4u::ExecSeq -============ +================== +⁣    class ExecSeq +================== .. doxygentypedef:: ExecSeqPtr @@ -661,9 +698,9 @@ s4u::ExecSeq .. _API_s4u_ExecPar: -============ -s4u::ExecPar -============ +================== +⁣    class ExecPar +================== .. doxygentypedef:: ExecParPtr @@ -672,22 +709,11 @@ s4u::ExecPar :protected-members: :undoc-members: -.. _API_s4u_Host: - -========= -s4u::Host -========= - -.. doxygenclass:: simgrid::s4u::Host - :members: - :protected-members: - :undoc-members: - .. _API_s4u_Io: -======= -s4u::Io -======= +=========== +⁣  class Io +=========== .. doxygentypedef:: IoPtr @@ -696,78 +722,71 @@ s4u::Io :protected-members: :undoc-members: -.. _API_s4u_Link: +.. _API_s4u_Synchronizations: -========= -s4u::Link -========= +======================= +Synchronization Objects +======================= -.. doxygenclass:: simgrid::s4u::Link - :members: - :protected-members: - :undoc-members: +.. _API_s4u_Barrier: -.. _API_s4u_Mailbox: +================ +⁣  class Barrier +================ -============ -s4u::Mailbox -============ +.. doxygentypedef:: BarrierPtr -Please also refer to the :ref:`full doc on s4u::Mailbox `. +.. autodoxyclass:: simgrid::s4u::Barrier -.. doxygenclass:: simgrid::s4u::Mailbox - :members: - :protected-members: - :undoc-members: + .. tabs:: -.. _API_s4u_Mutex: + .. group-tab:: C++ -========== -s4u::Mutex -========== + .. autodoxymethod:: simgrid::s4u::Barrier::Barrier(unsigned int count) + .. autodoxymethod:: simgrid::s4u::Barrier::create(unsigned int expected_actors) + .. autodoxymethod:: simgrid::s4u::Barrier::wait() -.. doxygentypedef:: MutexPtr -.. doxygenclass:: simgrid::s4u::Mutex - :members: - :protected-members: - :undoc-members: +.. _API_s4u_ConditionVariable: -.. _API_s4u_NetZone: +========================== +⁣  class ConditionVariable +========================== -============ -s4u::NetZone -============ +.. doxygentypedef:: ConditionVariablePtr -.. doxygenclass:: simgrid::s4u::NetZone +.. doxygenclass:: simgrid::s4u::ConditionVariable :members: :protected-members: :undoc-members: -.. _API_s4u_Semaphore: +.. _API_s4u_Mutex: ============== -s4u::Semaphore +⁣  class Mutex ============== -.. doxygentypedef:: SemaphorePtr +.. doxygentypedef:: MutexPtr -.. doxygenclass:: simgrid::s4u::Semaphore +.. doxygenclass:: simgrid::s4u::Mutex :members: :protected-members: :undoc-members: -.. _API_s4u_VirtualMachine: +.. _API_s4u_Semaphore: -=================== -s4u::VirtualMachine -=================== +================== +⁣  class Semaphore +================== -.. doxygenclass:: simgrid::s4u::VirtualMachine +.. doxygentypedef:: SemaphorePtr + +.. doxygenclass:: simgrid::s4u::Semaphore :members: :protected-members: :undoc-members: + C API Reference ***************