From 512273b5dab057e0f93aaed9c09c79d0e4960b61 Mon Sep 17 00:00:00 2001 From: Martin Quinson Date: Sat, 18 Nov 2023 16:32:43 +0100 Subject: [PATCH] Fix some more doc errors. There is so many of them :( --- docs/Build.sh | 2 +- docs/find-missing.ignore | 3 ++ docs/source/Doxyfile | 1 + docs/source/app_s4u.rst | 53 +++++++++++++++++++++++------------- examples/README.rst | 8 +++--- include/xbt/function_types.h | 3 ++ 6 files changed, 46 insertions(+), 24 deletions(-) diff --git a/docs/Build.sh b/docs/Build.sh index fa133ad9a7..8aa516b1c9 100755 --- a/docs/Build.sh +++ b/docs/Build.sh @@ -66,4 +66,4 @@ else fi echo "Undocumented symbols:" -./find-missing.py \ No newline at end of file +./find-missing.py 2>&1 diff --git a/docs/find-missing.ignore b/docs/find-missing.ignore index 1f263180fd..f7581519da 100644 --- a/docs/find-missing.ignore +++ b/docs/find-missing.ignore @@ -33,3 +33,6 @@ It is only used by find-missing, that will not report any definition linked here .. doxygentypedef:: s4u_NetZone .. doxygentypedef:: s4u_Semaphore .. doxygentypedef:: s4u_VM +.. doxygentypedef:: s4u_Activity +.. doxygentypedef:: s4u_ActivitySet +.. doxygentypedef:: s4u_MessageQueue \ No newline at end of file diff --git a/docs/source/Doxyfile b/docs/source/Doxyfile index fcf85af555..30041d4a6b 100644 --- a/docs/source/Doxyfile +++ b/docs/source/Doxyfile @@ -21,6 +21,7 @@ INPUT += ../../include/simgrid/semaphore.h INPUT += ../../include/simgrid/vm.h INPUT += ../../include/simgrid/zone.h INPUT += ../../include/smpi/smpi.h +INPUT += ../../include/xbt/function_types.h INPUT += ../../include/xbt/dynar.h INPUT += ../../src/xbt/dynar.cpp INPUT += ../../include/xbt/signal.hpp diff --git a/docs/source/app_s4u.rst b/docs/source/app_s4u.rst index fa0f6b5fa5..8c5a6e8ffe 100644 --- a/docs/source/app_s4u.rst +++ b/docs/source/app_s4u.rst @@ -828,7 +828,6 @@ Engin initialization .. doxygenfunction:: simgrid::s4u::Engine::Engine(int *argc, char **argv) .. doxygenfunction:: simgrid::s4u::Engine::is_initialized() - .. doxygenfunction:: simgrid::s4u::Engine::shutdown() .. doxygenfunction:: simgrid::s4u::Engine::get_instance() .. group-tab:: Python @@ -1578,9 +1577,7 @@ Basic management #include .. doxygentypedef:: sg_link_t - .. cpp:type:: const s4u_Link* const_sg_link_t - - Pointer to a constant link object. + .. doxygentypedef:: const_sg_link_t Retrieving links ---------------- @@ -1620,7 +1617,7 @@ Querying info .. doxygenfunction:: simgrid::s4u::Link::get_name() const .. doxygenfunction:: simgrid::s4u::Link::get_sharing_policy() const .. doxygenfunction:: simgrid::s4u::Link::get_concurrency_limit() const - .. doxygenfunction:: simgrid::s4u::Link::get_usage() const + .. doxygenfunction:: simgrid::s4u::Link::get_load() const .. doxygenfunction:: simgrid::s4u::Link::is_used() const .. group-tab:: Python @@ -1821,7 +1818,7 @@ Querying info .. doxygenfunction:: simgrid::s4u::NetZone::get_cname() const .. doxygenfunction:: simgrid::s4u::NetZone::get_name() const - .. doxygenfunction:: simgrid::s4u::NetZone::get_netpoint() + .. doxygenfunction:: simgrid::s4u::NetZone::get_netpoint .. group-tab:: Python @@ -1874,8 +1871,10 @@ Routing data .. group-tab:: C++ .. doxygenfunction:: simgrid::s4u::NetZone::add_component(kernel::routing::NetPoint *elm) - .. doxygenfunction:: simgrid::s4u::NetZone::add_route - .. doxygenfunction:: simgrid::s4u::NetZone::add_bypass_route + .. doxygenfunction:: simgrid::s4u::NetZone::add_route(const Host *src, const Host *dst, const std::vector< LinkInRoute > &link_list, bool symmetrical=true) + .. doxygenfunction:: simgrid::s4u::NetZone::add_route(const Host *src, const Host *dst, const std::vector< const Link * > &links) + .. doxygenfunction:: simgrid::s4u::NetZone::add_route(const NetZone *src, const NetZone *dst, const std::vector< LinkInRoute > &link_list, bool symmetrical=true) + .. doxygenfunction:: simgrid::s4u::NetZone::add_route(const NetZone *src, const NetZone *dst, const std::vector< const Link * > &links) .. doxygenfunction:: simgrid::s4u::NetZone::get_children() const .. doxygenfunction:: simgrid::s4u::NetZone::get_parent() const .. doxygenfunction:: simgrid::s4u::NetZone::set_parent(const NetZone* parent) @@ -1943,6 +1942,10 @@ Hosts .. doxygenfunction:: simgrid::s4u::NetZone::create_host(const std::string& name, double speed) .. doxygenfunction:: simgrid::s4u::NetZone::create_host(const std::string& name, const std::vector& speed_per_pstate) .. doxygenfunction:: simgrid::s4u::NetZone::create_host(const std::string& name, const std::string& speed) + .. doxygenfunction:: simgrid::s4u::NetZone::create_host(const std::string &name, const std::string &speed) + .. doxygenfunction:: simgrid::s4u::NetZone::create_host(const std::string &name, const std::vector< double > &speed_per_pstate) + .. doxygenfunction:: simgrid::s4u::NetZone::create_host(const std::string &name, const std::vector< std::string > &speed_per_pstate) + .. doxygenfunction:: simgrid::s4u::NetZone::create_host(const std::string &name, double speed) .. group-tab:: Python @@ -1955,12 +1958,12 @@ Links .. group-tab:: C++ - .. doxygenfunction:: simgrid::s4u::NetZone::create_link(const std::string& name, const std::vector& bandwidths) - .. doxygenfunction:: simgrid::s4u::NetZone::create_link(const std::string& name, double bandwidth) - .. doxygenfunction:: simgrid::s4u::NetZone::create_link(const std::string& name, const std::vector& bandwidthds) - .. doxygenfunction:: simgrid::s4u::NetZone::create_link(const std::string& name, const std::string& bandwidth) - .. doxygenfunction:: simgrid::s4u::NetZone::create_split_duplex_link(const std::string& name, const std::string& bandwidth) - .. doxygenfunction:: simgrid::s4u::NetZone::create_split_duplex_link(const std::string& name, double bandwidth) + .. doxygenfunction:: simgrid::s4u::NetZone::create_link(const std::string &name, const std::vector< double > &bandwidths) + .. doxygenfunction:: simgrid::s4u::NetZone::create_link(const std::string &name, double bandwidth) + .. doxygenfunction:: simgrid::s4u::NetZone::create_link(const std::string &name, const std::vector< std::string > &bandwidths) + .. doxygenfunction:: simgrid::s4u::NetZone::create_link(const std::string &name, const std::string &bandwidth) + .. doxygenfunction:: simgrid::s4u::NetZone::create_split_duplex_link(const std::string &name, const std::string &bandwidth) + .. doxygenfunction:: simgrid::s4u::NetZone::create_split_duplex_link(const std::string &name, double bandwidth) .. group-tab:: Python @@ -2132,6 +2135,11 @@ Basic management .. doxygentypedef:: ActivityPtr + .. group-tab:: C + + .. doxygentypedef:: sg_activity_t + .. doxygentypedef:: const_sg_activity_t + Querying info ------------- @@ -2319,15 +2327,21 @@ Signals .. group-tab:: C++ - .. doxygenfunction:: simgrid::s4u::Comm::on_start_cb - .. doxygenfunction:: simgrid::s4u::Comm::on_this_start_cb .. doxygenfunction:: simgrid::s4u::Comm::on_completion_cb - .. doxygenfunction:: simgrid::s4u::Comm::on_this_completion_cb + .. doxygenfunction:: simgrid::s4u::Comm::on_start_cb .. doxygenfunction:: simgrid::s4u::Comm::on_recv_cb .. doxygenfunction:: simgrid::s4u::Comm::on_send_cb .. doxygenfunction:: simgrid::s4u::Comm::on_suspended_cb + .. doxygenfunction:: simgrid::s4u::Comm::on_suspend_cb + .. doxygenfunction:: simgrid::s4u::Comm::on_resume_cb .. doxygenfunction:: simgrid::s4u::Comm::on_resumed_cb .. doxygenfunction:: simgrid::s4u::Comm::on_veto_cb + .. doxygenfunction:: simgrid::s4u::Comm::on_this_completion_cb + .. doxygenfunction:: simgrid::s4u::Comm::on_this_recv_cb + .. doxygenfunction:: simgrid::s4u::Comm::on_this_resume_cb + .. doxygenfunction:: simgrid::s4u::Comm::on_this_send_cb + .. doxygenfunction:: simgrid::s4u::Comm::on_this_start_cb + .. doxygenfunction:: simgrid::s4u::Comm::on_this_suspended_cb .. doxygenfunction:: simgrid::s4u::Comm::on_this_veto_cb .. _API_s4u_Exec: @@ -2560,8 +2574,8 @@ Signals .. group-tab:: C - .. doxygentypedef:: sg_activityset_t - .. doxygentypedef:: const_sg_activityset_t + .. doxygentypedef:: sg_activity_set_t + .. doxygentypedef:: const_sg_activity_set_t Basic management ---------------- @@ -2973,6 +2987,7 @@ Locking .. doxygenfunction:: simgrid::s4u::Barrier::create(unsigned int expected_actors) .. doxygenfunction:: simgrid::s4u::Barrier::wait() + .. doxygenfunction:: simgrid::s4u::Barrier::to_string() .. group-tab:: Python diff --git a/examples/README.rst b/examples/README.rst index 991d2ace58..9b22d37a1c 100644 --- a/examples/README.rst +++ b/examples/README.rst @@ -687,7 +687,7 @@ The ``wait_all()`` function is useful when you want to block until all activitie .. example-tab:: examples/c/activityset-waitall/activityset-waitall.c - See also :cpp:func:`sg_activityset_wait_all()`. + See also :cpp:func:`sg_activity_set_wait_all()`. Waiting for all activities in a set (with timeout) -------------------------------------------------- @@ -706,7 +706,7 @@ The ``wait_all_for()`` function is very similar to ``wait_all()`` but allows to .. example-tab:: examples/c/activityset-waitallfor/activityset-waitallfor.c - See also :cpp:func:`sg_activityset_wait_all_for()`. + See also :cpp:func:`sg_activity_set_wait_all_for()`. Waiting for the first completed activity in a set ------------------------------------------------- @@ -725,7 +725,7 @@ The ``wait_any()`` blocks until one activity of the set completes, no matter whi .. example-tab:: examples/c/activityset-waitany/activityset-waitany.c - See also :cpp:func:`sg_activityset_wait_any`. + See also :cpp:func:`sg_activity_set_wait_any`. Testing whether at least one activity completed ----------------------------------------------- @@ -744,7 +744,7 @@ The ``test_any()`` returns whether at least one activity of the set has complete .. example-tab:: examples/c/activityset-testany/activityset-testany.c - See also :cpp:func:`sg_activityset_test_any`. + See also :cpp:func:`sg_activity_set_test_any`. .. _s4u_ex_dag: diff --git a/include/xbt/function_types.h b/include/xbt/function_types.h index 37dd5f53f6..16431a1c2a 100644 --- a/include/xbt/function_types.h +++ b/include/xbt/function_types.h @@ -22,6 +22,9 @@ typedef int (*int_f_int_pvoid_t)(int, void*); typedef int (*int_f_pvoid_pvoid_t) (void *, void *); typedef int (*int_f_cpvoid_cpvoid_t) (const void *, const void *); +/** Prototype of an actor's main function + * + * The only difference with a classical main() in C is that the return type is void */ typedef void (*xbt_main_func_t)(int argc, char* argv[]); SG_END_DECL -- 2.20.1