From: Arnaud Giersch Date: Fri, 22 Apr 2022 12:22:56 +0000 (+0200) Subject: Fix some warnings in doc generation. X-Git-Tag: v3.32~308 X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/472cf2ae0b7d14830217c5a0024c5c27c2336af4 Fix some warnings in doc generation. --- diff --git a/docs/source/app_msg.rst b/docs/source/app_msg.rst index ebfc632cca..d3dc33e474 100644 --- a/docs/source/app_msg.rst +++ b/docs/source/app_msg.rst @@ -359,7 +359,6 @@ Package org.simgrid.msg Class org.simgrid.msg.As Class org.simgrid.msg.Comm - Class org.simgrid.msg.File Class org.simgrid.msg.Host Class org.simgrid.msg.HostFailureException Class org.simgrid.msg.HostNotFoundException @@ -371,8 +370,6 @@ Package org.simgrid.msg Class org.simgrid.msg.ProcessKilledError Class org.simgrid.msg.ProcessNotFoundException Class org.simgrid.msg.Semaphore - Class org.simgrid.msg.Storage - Class org.simgrid.msg.StorageNotFoundException Class org.simgrid.msg.Task Class org.simgrid.msg.TaskCancelledException Class org.simgrid.msg.TimeoutException diff --git a/docs/source/app_s4u.rst b/docs/source/app_s4u.rst index a463115b34..014a1e96ed 100644 --- a/docs/source/app_s4u.rst +++ b/docs/source/app_s4u.rst @@ -747,6 +747,7 @@ the execution, or start an asynchronous activity. .. group-tab:: Python + .. autofunction:: simgrid.this_actor.exec_async .. autofunction:: simgrid.this_actor.exec_init .. autofunction:: simgrid.this_actor.execute @@ -908,7 +909,7 @@ Retrieving hosts .. group-tab:: Python .. autoattribute:: simgrid.Engine.all_hosts - .. automethod:: simgrid::s4u::Engine::host_by_name + .. automethod:: simgrid.Engine.host_by_name .. group-tab:: C @@ -1174,7 +1175,7 @@ Querying info .. doxygenfunction:: simgrid::s4u::Disk::get_read_bandwidth() const .. doxygenfunction:: simgrid::s4u::Disk::get_write_bandwidth() const .. doxygenfunction:: simgrid::s4u::Disk::set_property(const std::string &, const std::string &value) - .. doxygenfunction:: simgrid::s4u::Disk::set_sharing_policy(Operation op, SharingPolicy policy, const s4u::NonLinearResourceCb& cb = {}) + .. doxygenfunction:: simgrid::s4u::Disk::set_sharing_policy .. group-tab:: Python @@ -1301,11 +1302,12 @@ Modifying characteristics .. doxygenfunction:: simgrid::s4u::Host::set_core_count(int core_count) .. doxygenfunction:: simgrid::s4u::Host::set_coordinates(const std::string& coords) - .. doxygenfunction:: simgrid::s4u::Host::set_sharing_policy(SharingPolicy policy, const s4u::NonLinearResourceCb& cb = {}) + .. doxygenfunction:: simgrid::s4u::Host::set_sharing_policy .. group-tab:: Python .. autoattribute:: simgrid.Host.core_count + :noindex: .. automethod:: simgrid.Host.set_coordinates .. automethod:: simgrid.Host.set_sharing_policy @@ -1328,7 +1330,6 @@ Querying info .. autoattribute:: simgrid.Host.name .. autoattribute:: simgrid.Host.core_count .. autoattribute:: simgrid.Host.load - .. autoattribute:: simgrid.Host.pstate .. autoattribute:: simgrid.Host.speed .. autoattribute:: simgrid.Host.available_speed @@ -1411,6 +1412,7 @@ DVFS .. group-tab:: Python + .. autoattribute:: simgrid.Host.pstate .. autoattribute:: simgrid.Host.pstate_count .. automethod:: simgrid.Host.pstate_speed @@ -1609,7 +1611,7 @@ Modifying characteristics .. doxygenfunction:: simgrid::s4u::Link::set_latency(double value) .. doxygenfunction:: simgrid::s4u::Link::set_latency(const std::string& value) .. doxygenfunction:: simgrid::s4u::Link::set_concurrency_limit(int limit) - .. doxygenfunction:: simgrid::s4u::Link::set_sharing_policy(SharingPolicy policy, const NonLinearResourceCb& cb = {}) + .. doxygenfunction:: simgrid::s4u::Link::set_sharing_policy .. group-tab:: Python @@ -1868,16 +1870,16 @@ Zones .. group-tab:: C++ - .. doxygenfunction:: simgrid::s4u::create_full_zone(const std::string& name) - .. doxygenfunction:: simgrid::s4u::create_empty_zone(const std::string& name) - .. doxygenfunction:: simgrid::s4u::create_star_zone(const std::string& name) - .. doxygenfunction:: simgrid::s4u::create_dijkstra_zone(const std::string& name, bool cache) - .. doxygenfunction:: simgrid::s4u::create_floyd_zone(const std::string& name) - .. doxygenfunction:: simgrid::s4u::create_vivaldi_zone(const std::string& name) - .. doxygenfunction:: simgrid::s4u::create_wifi_zone(const std::string& name) + .. doxygenfunction:: simgrid::s4u::create_full_zone + .. doxygenfunction:: simgrid::s4u::create_empty_zone + .. doxygenfunction:: simgrid::s4u::create_star_zone + .. doxygenfunction:: simgrid::s4u::create_dijkstra_zone + .. doxygenfunction:: simgrid::s4u::create_floyd_zone + .. doxygenfunction:: simgrid::s4u::create_vivaldi_zone + .. doxygenfunction:: simgrid::s4u::create_wifi_zone .. doxygenfunction:: simgrid::s4u::create_torus_zone - .. doxygenfunction:: simgrid::s4u::create_fatTree_zone(const std::string& name, const NetZone* parent, const FatTreeParams& parameters, const ClusterCallbacks& set_callbacks, double bandwidth, double latency, Link::SharingPolicy sharing_policy) - .. doxygenfunction:: simgrid::s4u::create_dragonfly_zone(const std::string& name, const NetZone* parent, const DragonflyParams& parameters, const ClusterCallbacks& set_callbacks, double bandwidth, double latency, Link::SharingPolicy sharing_policy) + .. doxygenfunction:: simgrid::s4u::create_fatTree_zone + .. doxygenfunction:: simgrid::s4u::create_dragonfly_zone .. group-tab:: Python @@ -2133,8 +2135,8 @@ Signals .. group-tab:: C++ .. doxygenfunction:: simgrid::s4u::Activity::on_completion_cb - .. doxygenfunction:: simgrid::s4u::Activity::on_suspend_cb - .. doxygenfunction:: simgrid::s4u::Activity::on_resume_cb + .. doxygenfunction:: simgrid::s4u::Activity::on_suspended_cb + .. doxygenfunction:: simgrid::s4u::Activity::on_resumed_cb .. _API_s4u_Comm: @@ -2208,7 +2210,6 @@ Querying info .. automethod:: simgrid.Comm.detach .. automethod:: simgrid.Comm.set_payload_size .. automethod:: simgrid.Comm.set_rate - .. automethod:: simgrid.Comm.detach Life cycle ---------- diff --git a/docs/source/community.rst b/docs/source/community.rst index f465374001..ec8c3dbefd 100644 --- a/docs/source/community.rst +++ b/docs/source/community.rst @@ -67,7 +67,7 @@ Spread the word ^^^^^^^^^^^^^^^ A simple way to help the SimGrid project is to **use SimGrid for your research, and say so**. -`Cite the SimGrid framework`_ in your papers and speak of it with your colleagues to spread the word. +`Cite the SimGrid framework `_ in your papers and speak of it with your colleagues to spread the word. The number of publications enabled by SimGrid is really important when asking for further fundings to sustain the project: The more you use the framework, the better for us. diff --git a/docs/source/conf.py b/docs/source/conf.py index 0b1a27ccd9..03d7271983 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -97,6 +97,8 @@ nitpick_ignore = [ ('cpp:identifier', 'kernel::resource::Action::State'), ('cpp:identifier', 'kernel::resource::LinkImpl'), ('cpp:identifier', 'kernel::resource::NetworkAction'), + ('cpp:identifier', 'kernel::resource::SplitDuplexLinkImpl'), + ('cpp:identifier', 'kernel::resource::StandardLinkImpl'), ('cpp:identifier', 'kernel::routing'), ('cpp:identifier', 'kernel::routing::NetPoint'), ('cpp:identifier', 'ns3'), @@ -107,6 +109,7 @@ nitpick_ignore = [ ('cpp:identifier', 's4u_Barrier'), ('cpp:identifier', 's4u_Comm'), ('cpp:identifier', 's4u_ConditionVariable'), + ('cpp:identifier', 's4u_Disk'), ('cpp:identifier', 's4u_Exec'), ('cpp:identifier', 's4u_File'), ('cpp:identifier', 's4u_Host'), diff --git a/examples/README.rst b/examples/README.rst index 45b314f322..9fe8b5f8cc 100644 --- a/examples/README.rst +++ b/examples/README.rst @@ -481,12 +481,12 @@ You can start asynchronous executions, just like you would fire background threa .. example-tab:: examples/python/exec-async/exec-async.py See also :py:func:`simgrid.this_actor.exec_init()`, - :py:func:`simgrid.Activity.start()`, - :py:func:`simgrid.Activity.wait()`, + :py:func:`simgrid.Exec.start()`, + :py:func:`simgrid.Exec.wait()`, :py:attr:`simgrid.Exec.remaining`, :py:attr:`simgrid.Exec.remaining_ratio`, :py:func:`simgrid.this_actor.exec_async()` and - :py:func:`simgrid.Activity.cancel()`. + :py:func:`simgrid.Exec.cancel()`. .. example-tab:: examples/c/exec-async/exec-async.c @@ -558,7 +558,7 @@ of a host can then be accessed and changed from the program. .. example-tab:: examples/python/exec-dvfs/exec-dvfs.py - See also :py:attr:`Host.pstate_speed` and :py:func:`Host.set_pstate()`. + See also :py:func:`simgrid.Host.pstate_speed()` and :py:attr:`simgrid.Host.pstate`. .. example-tab:: examples/platforms/energy_platform.xml diff --git a/include/simgrid/s4u/Host.hpp b/include/simgrid/s4u/Host.hpp index f495f03999..6208ff0c08 100644 --- a/include/simgrid/s4u/Host.hpp +++ b/include/simgrid/s4u/Host.hpp @@ -156,11 +156,11 @@ public: * @verbatim embed:rst:inline :cpp:func:`get_pstate_speed() ` @endverbatim * to retrieve the computing speed you would get at another pstate) * - If you declared an external load (with - * @verbatim embed:rst:inline :cpp:func:`set_speed_profile() ` - * @endverbatim ), you must multiply the result of + * @verbatim embed:rst:inline :cpp:func:`set_speed_profile() ` @endverbatim ), + * you must multiply the result of * @verbatim embed:rst:inline :cpp:func:`get_speed() ` @endverbatim by - * @verbatim embed:rst:inline :cpp:func:`get_available_speed() ` - * @endverbatim to retrieve what a new computation would get. + * @verbatim embed:rst:inline :cpp:func:`get_available_speed() ` @endverbatim + * to retrieve what a new computation would get. * * The remaining speed is then shared between the executions located on this host. * You can retrieve the amount of tasks currently running on this host with