From 3907e83884bae6278656e9cd2cb7ef92a8f707fb Mon Sep 17 00:00:00 2001 From: Martin Quinson Date: Fri, 17 Nov 2023 00:21:58 +0100 Subject: [PATCH] Fix some more doc bugs --- docs/Build.sh | 2 ++ docs/source/Plugins.rst | 16 ++++++++-------- docs/source/app_s4u.rst | 6 +++++- include/simgrid/plugins/chiller.hpp | 6 ++++-- include/simgrid/plugins/solar_panel.hpp | 2 ++ 5 files changed, 21 insertions(+), 11 deletions(-) diff --git a/docs/Build.sh b/docs/Build.sh index e55855c7da..fa133ad9a7 100755 --- a/docs/Build.sh +++ b/docs/Build.sh @@ -65,3 +65,5 @@ else echo "Install linkchecker to have it executed when you build the doc." fi +echo "Undocumented symbols:" +./find-missing.py \ No newline at end of file diff --git a/docs/source/Plugins.rst b/docs/source/Plugins.rst index 4b879dd9de..aab0fe0968 100644 --- a/docs/source/Plugins.rst +++ b/docs/source/Plugins.rst @@ -144,18 +144,18 @@ Existing signals :cpp:func:`Comm::on_this_start ` :cpp:func:`Comm::on_completion ` :cpp:func:`Comm::on_this_completion ` - :cpp:func:`Comm::on_suspend ` - :cpp:func:`Comm::on_this_suspend ` + :cpp:func:`Comm::on_suspended ` + :cpp:func:`Comm::on_this_suspended ` :cpp:func:`Comm::on_resume ` - :cpp:func:`Comm::on_this_resume ` + :cpp:func:`Comm::on_this_resumed ` :cpp:func:`Comm::on_veto ` :cpp:func:`Comm::on_this_veto ` - :cpp:func:`Exec::on_start ` :cpp:func:`Exec::on_this_start ` :cpp:func:`Exec::on_completion ` :cpp:func:`Exec::on_this_completion ` - :cpp:func:`Exec::on_suspend ` - :cpp:func:`Exec::on_this_suspend ` + :cpp:func:`Exec::on_suspended ` + :cpp:func:`Exec::on_this_suspended ` :cpp:func:`Exec::on_resume ` :cpp:func:`Exec::on_this_resume ` :cpp:func:`Exec::on_veto ` @@ -164,10 +164,10 @@ Existing signals :cpp:func:`Io::on_this_start ` :cpp:func:`Io::on_completion ` :cpp:func:`Io::on_this_completion ` - :cpp:func:`Io::on_suspend ` - :cpp:func:`Io::on_this_suspend ` + :cpp:func:`Io::on_suspended ` + :cpp:func:`Io::on_this_suspended ` :cpp:func:`Io::on_resume ` - :cpp:func:`Io::on_this_resume ` + :cpp:func:`Io::on_this_resumed ` :cpp:func:`Io::on_veto ` :cpp:func:`Io::on_this_veto ` diff --git a/docs/source/app_s4u.rst b/docs/source/app_s4u.rst index f12436c7f7..fa0f6b5fa5 100644 --- a/docs/source/app_s4u.rst +++ b/docs/source/app_s4u.rst @@ -471,6 +471,8 @@ See also :ref:`the relevant example `. .. group-tab:: C + .. doxygentypedef:: xbt_main_func_t + .. doxygenfunction:: sg_actor_create(const char *name, sg_host_t host, xbt_main_func_t code, int argc, char *const *argv) .. doxygenfunction:: sg_actor_init(const char *name, sg_host_t host) .. doxygenfunction:: sg_actor_start(sg_actor_t actor, xbt_main_func_t code, int argc, char *const *argv) @@ -2158,7 +2160,6 @@ Activities life cycle .. doxygenfunction:: simgrid::s4u::Activity::wait .. doxygenfunction:: simgrid::s4u::Activity::wait_for .. doxygenfunction:: simgrid::s4u::Activity::wait_until(double time_limit) - .. doxygenfunction:: simgrid::s4u::Activity::vetoable_start() Suspending and resuming an activity ----------------------------------- @@ -2327,6 +2328,7 @@ Signals .. doxygenfunction:: simgrid::s4u::Comm::on_suspended_cb .. doxygenfunction:: simgrid::s4u::Comm::on_resumed_cb .. doxygenfunction:: simgrid::s4u::Comm::on_veto_cb + .. doxygenfunction:: simgrid::s4u::Comm::on_this_veto_cb .. _API_s4u_Exec: @@ -2465,6 +2467,7 @@ Signals .. doxygenfunction:: simgrid::s4u::Exec::on_suspended_cb .. doxygenfunction:: simgrid::s4u::Exec::on_resumed_cb .. doxygenfunction:: simgrid::s4u::Exec::on_veto_cb + .. doxygenfunction:: simgrid::s4u::Exec::on_this_veto_cb .. _API_s4u_Io: @@ -2537,6 +2540,7 @@ Signals .. doxygenfunction:: simgrid::s4u::Io::on_suspended_cb .. doxygenfunction:: simgrid::s4u::Io::on_resumed_cb .. doxygenfunction:: simgrid::s4u::Io::on_veto_cb + .. doxygenfunction:: simgrid::s4u::Io::on_this_veto_cb .. _API_s4u_ActivitySet: diff --git a/include/simgrid/plugins/chiller.hpp b/include/simgrid/plugins/chiller.hpp index bf28b485c8..11fa173477 100644 --- a/include/simgrid/plugins/chiller.hpp +++ b/include/simgrid/plugins/chiller.hpp @@ -11,7 +11,9 @@ namespace simgrid::plugins { +/** @ingroup plugin_chiller */ class Chiller; +/** @ingroup plugin_chiller */ using ChillerPtr = boost::intrusive_ptr; XBT_PUBLIC void intrusive_ptr_release(Chiller* o); XBT_PUBLIC void intrusive_ptr_add_ref(Chiller* o); @@ -83,8 +85,8 @@ public: ChillerPtr set_goal_temp(double goal_temp_c); ChillerPtr set_max_power(double max_power_w); ChillerPtr set_active(bool active); - ChillerPtr add_host(s4u::Host* host); - ChillerPtr remove_host(s4u::Host* host); + ChillerPtr add_host(simgrid::s4u::Host* host); + ChillerPtr remove_host(simgrid::s4u::Host* host); std::string get_name() { return name_; } const char* get_cname() { return name_.c_str(); } diff --git a/include/simgrid/plugins/solar_panel.hpp b/include/simgrid/plugins/solar_panel.hpp index 0ba319c059..849c366c1f 100644 --- a/include/simgrid/plugins/solar_panel.hpp +++ b/include/simgrid/plugins/solar_panel.hpp @@ -11,7 +11,9 @@ namespace simgrid::plugins { +/** @ingroup plugin_solar_panel */ class SolarPanel; +/** @ingroup plugin_solar_panel */ using SolarPanelPtr = boost::intrusive_ptr; XBT_PUBLIC void intrusive_ptr_release(SolarPanel* o); XBT_PUBLIC void intrusive_ptr_add_ref(SolarPanel* o); -- 2.20.1