Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Fix some more doc bugs
authorMartin Quinson <martin.quinson@ens-rennes.fr>
Thu, 16 Nov 2023 23:21:58 +0000 (00:21 +0100)
committerMartin Quinson <martin.quinson@ens-rennes.fr>
Thu, 16 Nov 2023 23:21:58 +0000 (00:21 +0100)
docs/Build.sh
docs/source/Plugins.rst
docs/source/app_s4u.rst
include/simgrid/plugins/chiller.hpp
include/simgrid/plugins/solar_panel.hpp

index e55855c..fa133ad 100755 (executable)
@@ -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
index 4b879dd..aab0fe0 100644 (file)
@@ -144,18 +144,18 @@ Existing signals
     :cpp:func:`Comm::on_this_start <simgrid::s4u::Comm::on_this_start_cb>`
     :cpp:func:`Comm::on_completion <simgrid::s4u::Comm::on_completion_cb>`
     :cpp:func:`Comm::on_this_completion <simgrid::s4u::Comm::on_this_completion_cb>`
-    :cpp:func:`Comm::on_suspend <simgrid::s4u::Comm::on_suspend_cb>`
-    :cpp:func:`Comm::on_this_suspend <simgrid::s4u::Comm::on_this_suspend_cb>`
+    :cpp:func:`Comm::on_suspended <simgrid::s4u::Comm::on_suspended_cb>`
+    :cpp:func:`Comm::on_this_suspended <simgrid::s4u::Comm::on_this_suspended_cb>`
     :cpp:func:`Comm::on_resume <simgrid::s4u::Comm::on_resume_cb>`
-    :cpp:func:`Comm::on_this_resume <simgrid::s4u::Comm::on_this_resume_cb>`
+    :cpp:func:`Comm::on_this_resumed <simgrid::s4u::Comm::on_this_resumed_cb>`
     :cpp:func:`Comm::on_veto <simgrid::s4u::Comm::on_veto_cb>`
     :cpp:func:`Comm::on_this_veto <simgrid::s4u::Comm::on_this_veto_cb>`
   - :cpp:func:`Exec::on_start <simgrid::s4u::Exec::on_start_cb>`
     :cpp:func:`Exec::on_this_start <simgrid::s4u::Exec::on_this_start_cb>`
     :cpp:func:`Exec::on_completion <simgrid::s4u::Exec::on_completion_cb>`
     :cpp:func:`Exec::on_this_completion <simgrid::s4u::Exec::on_this_completion_cb>`
-    :cpp:func:`Exec::on_suspend <simgrid::s4u::Exec::on_suspend_cb>`
-    :cpp:func:`Exec::on_this_suspend <simgrid::s4u::Exec::on_this_suspend_cb>`
+    :cpp:func:`Exec::on_suspended <simgrid::s4u::Exec::on_suspended_cb>`
+    :cpp:func:`Exec::on_this_suspended <simgrid::s4u::Exec::on_this_suspended_cb>`
     :cpp:func:`Exec::on_resume <simgrid::s4u::Exec::on_resume_cb>`
     :cpp:func:`Exec::on_this_resume <simgrid::s4u::Exec::on_this_resume_cb>`
     :cpp:func:`Exec::on_veto <simgrid::s4u::Exec::on_veto_cb>`
@@ -164,10 +164,10 @@ Existing signals
     :cpp:func:`Io::on_this_start <simgrid::s4u::Io::on_this_start_cb>`
     :cpp:func:`Io::on_completion <simgrid::s4u::Io::on_completion_cb>`
     :cpp:func:`Io::on_this_completion <simgrid::s4u::Io::on_this_completion_cb>`
-    :cpp:func:`Io::on_suspend <simgrid::s4u::Io::on_suspend_cb>`
-    :cpp:func:`Io::on_this_suspend <simgrid::s4u::Io::on_this_suspend_cb>`
+    :cpp:func:`Io::on_suspended <simgrid::s4u::Io::on_suspended_cb>`
+    :cpp:func:`Io::on_this_suspended <simgrid::s4u::Io::on_this_suspended_cb>`
     :cpp:func:`Io::on_resume <simgrid::s4u::Io::on_resume_cb>`
-    :cpp:func:`Io::on_this_resume <simgrid::s4u::Io::on_this_resume_cb>`
+    :cpp:func:`Io::on_this_resumed <simgrid::s4u::Io::on_this_resumed_cb>`
     :cpp:func:`Io::on_veto <simgrid::s4u::Io::on_veto_cb>`
     :cpp:func:`Io::on_this_veto <simgrid::s4u::Io::on_this_veto_cb>`
 
index f12436c..fa0f6b5 100644 (file)
@@ -471,6 +471,8 @@ See also :ref:`the relevant example <s4u_ex_actors_create>`.
 
    .. 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:
 
index bf28b48..11fa173 100644 (file)
@@ -11,7 +11,9 @@
 
 namespace simgrid::plugins {
 
+/** @ingroup plugin_chiller */
 class Chiller;
+/** @ingroup plugin_chiller */
 using ChillerPtr = boost::intrusive_ptr<Chiller>;
 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(); }
index 0ba319c..849c366 100644 (file)
@@ -11,7 +11,9 @@
 
 namespace simgrid::plugins {
 
+/** @ingroup plugin_solar_panel */
 class SolarPanel;
+/** @ingroup plugin_solar_panel */
 using SolarPanelPtr = boost::intrusive_ptr<SolarPanel>;
 XBT_PUBLIC void intrusive_ptr_release(SolarPanel* o);
 XBT_PUBLIC void intrusive_ptr_add_ref(SolarPanel* o);