Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Fix another bunch of warnings in doc generation.
authorArnaud Giersch <arnaud.giersch@univ-fcomte.fr>
Fri, 9 Jul 2021 16:32:49 +0000 (18:32 +0200)
committerArnaud Giersch <arnaud.giersch@univ-fcomte.fr>
Fri, 9 Jul 2021 22:10:23 +0000 (00:10 +0200)
docs/source/Plugins.rst
docs/source/app_msg.rst
docs/source/conf.py
include/simgrid/forward.h
include/simgrid/plugins/file_system.h
include/simgrid/s4u/Link.hpp
src/bindings/java/org/simgrid/msg/Process.java

index 5bc1614..1ef1475 100644 (file)
@@ -152,8 +152,5 @@ File System
 
 .. doxygengroup:: plugin_filesystem
 
-.. doxygentypedef:: sg_file_t
-.. doxygentypedef:: const_sg_file_t
 
 ..  LocalWords:  SimGrid
-
index e3b0160..082e64b 100644 (file)
@@ -255,6 +255,8 @@ Network Zone (:cpp:type:`msg_netzone_t`) and associated functions.
 .. doxygenfunction:: MSG_zone_get_sons
 .. doxygenfunction:: MSG_zone_set_property_value
 
+.. _Java_doc:
+
 Java bindings
 *************
 
index 89b8cb2..171ae1b 100644 (file)
@@ -71,8 +71,8 @@ nitpick_ignore = [
   ('cpp:identifier', 'boost::intrusive_ptr<Activity>'),
   ('cpp:identifier', 'boost::intrusive_ptr<Actor>'),
   ('cpp:identifier', 'boost::intrusive_ptr<Barrier>'),
-  ('cpp:identifier', 'boost::intrusive_ptr<ConditionVariable>'),
   ('cpp:identifier', 'boost::intrusive_ptr<Comm>'),
+  ('cpp:identifier', 'boost::intrusive_ptr<ConditionVariable>'),
   ('cpp:identifier', 'boost::intrusive_ptr<Exec>'),
   ('cpp:identifier', 'boost::intrusive_ptr<Io>'),
   ('cpp:identifier', 'boost::intrusive_ptr<Mutex>'),
@@ -80,44 +80,73 @@ nitpick_ignore = [
   ('cpp:identifier', 'kernel'),
   ('cpp:identifier', 'kernel::activity'),
   ('cpp:identifier', 'kernel::activity::ActivityImplPtr'),
+  ('cpp:identifier', 'kernel::activity::CommImpl'),
   ('cpp:identifier', 'kernel::activity::CommImplPtr'),
   ('cpp:identifier', 'kernel::actor'),
   ('cpp:identifier', 'kernel::actor::ActorCodeFactory'),
   ('cpp:identifier', 'kernel::actor::ActorImpl'),
   ('cpp:identifier', 'kernel::profile'),
+  ('cpp:identifier', 'kernel::profile::Profile'),
   ('cpp:identifier', 'kernel::resource'),
   ('cpp:identifier', 'kernel::resource::Action'),
+  ('cpp:identifier', 'kernel::resource::Action::State'),
+  ('cpp:identifier', 'kernel::resource::LinkImpl'),
   ('cpp:identifier', 'kernel::resource::NetworkAction'),
   ('cpp:identifier', 'kernel::routing'),
   ('cpp:identifier', 'kernel::routing::NetPoint'),
-  ('cpp:identifier', 'sg_msg_Comm'),
-  ('cpp:identifier', 'sg_msg_Task'),
-  ('cpp:identifier', 'simgrid'),
-  ('cpp:identifier', 'simgrid::s4u'),
-  ('cpp:identifier', 'simgrid::s4u::this_actor'),
-  ('cpp:identifier', 'simgrid::s4u::Activity_T<Comm>'),
-  ('cpp:identifier', 'simgrid::s4u::Activity_T<Exec>'),
-  ('cpp:identifier', 'simgrid::s4u::Activity_T<Io>'),
-  ('cpp:identifier', 'simgrid::xbt'),
-  ('cpp:identifier', 'this_actor'),
   ('cpp:identifier', 's4u'),
   ('cpp:identifier', 's4u_Actor'),
   ('cpp:identifier', 's4u_Barrier'),
   ('cpp:identifier', 's4u_Comm'),
   ('cpp:identifier', 's4u_ConditionVariable'),
   ('cpp:identifier', 's4u_Exec'),
+  ('cpp:identifier', 's4u_File'),
   ('cpp:identifier', 's4u_Host'),
-  ('cpp:identifier', 's4u_NetZone'),
+  ('cpp:identifier', 's4u_Link'),
   ('cpp:identifier', 's4u_Mailbox'),
   ('cpp:identifier', 's4u_Mutex'),
-  ('cpp:identifier', 's4u_Link'),
+  ('cpp:identifier', 's4u_NetZone'),
   ('cpp:identifier', 's4u_Semaphore'),
-  ('cpp:identifier', 's4u_VirtualMachine'),
   ('cpp:identifier', 's4u_VM'),
+  ('cpp:identifier', 's4u_VirtualMachine'),
+  ('cpp:identifier', 'sg_msg_Comm'),
+  ('cpp:identifier', 'sg_msg_Task'),
+  ('cpp:identifier', 'simgrid'),
+  ('cpp:identifier', 'simgrid::s4u'),
+  ('cpp:identifier', 'simgrid::s4u::Activity_T<Comm>'),
+  ('cpp:identifier', 'simgrid::s4u::Activity_T<Exec>'),
+  ('cpp:identifier', 'simgrid::s4u::Activity_T<Io>'),
+  ('cpp:identifier', 'simgrid::s4u::this_actor'),
+  ('cpp:identifier', 'simgrid::xbt'),
+  ('cpp:identifier', 'simgrid::xbt::string'),
   ('cpp:identifier', 'size_t'),
+  ('cpp:identifier', 'ssize_t'),
+  ('cpp:identifier', 'this_actor'),
   ('cpp:identifier', 'uint64_t'),
   ('cpp:identifier', 'xbt'),
+  ('cpp:identifier', 'xbt::Extendable<Actor>'),
+  ('cpp:identifier', 'xbt::Extendable<Disk>'),
+  ('cpp:identifier', 'xbt::Extendable<File>'),
+  ('cpp:identifier', 'xbt::Extendable<Host>'),
+  ('cpp:identifier', 'xbt::Extendable<Link>'),
   ('cpp:identifier', 'xbt::signal<void()>'),
+  ('cpp:identifier', 'xbt::signal<void(Actor const&)>'),
+  ('cpp:identifier', 'xbt::signal<void(Actor&)>'),
+  ('cpp:identifier', 'xbt::signal<void(Comm const&)>'),
+  ('cpp:identifier', 'xbt::signal<void(Comm const&, bool is_sender)>'),
+  ('cpp:identifier', 'xbt::signal<void(Disk const&)>'),
+  ('cpp:identifier', 'xbt::signal<void(Disk&)>'),
+  ('cpp:identifier', 'xbt::signal<void(Exec const&)>'),
+  ('cpp:identifier', 'xbt::signal<void(Host const&)>'),
+  ('cpp:identifier', 'xbt::signal<void(Host&)>'),
+  ('cpp:identifier', 'xbt::signal<void(Link const&)>'),
+  ('cpp:identifier', 'xbt::signal<void(Link&)>'),
+  ('cpp:identifier', 'xbt::signal<void(NetZone const&)>'),
+  ('cpp:identifier', 'xbt::signal<void(VirtualMachine const&)>'),
+  ('cpp:identifier', 'xbt::signal<void(const Actor&, const Host &previous_location)>'),
+  ('cpp:identifier', 'xbt::signal<void(double)>'),
+  ('cpp:identifier', 'xbt::signal<void(kernel::resource::NetworkAction&)>'),
+  ('cpp:identifier', 'xbt::signal<void(kernel::resource::NetworkAction&, kernel::resource::Action::State)>'),
   ('cpp:identifier', 'xbt::signal<void(void)>'),
   ('cpp:identifier', 'xbt::string'),
 ]
index bbfbd1c..41ca22c 100644 (file)
@@ -274,9 +274,9 @@ typedef s4u_Link* sg_link_t;
 typedef const s4u_Link* const_sg_link_t;
 typedef s4u_Disk* sg_disk_t;
 typedef const s4u_Disk* const_sg_disk_t;
-/** Pointer to a SimGrid file object */
+/** Pointer to a SimGrid file object @ingroup plugin_filesystem */
 typedef s4u_File* sg_file_t;
-/** Constant pointer to a SimGrid file object */
+/** Constant pointer to a SimGrid file object @ingroup plugin_filesystem */
 typedef const s4u_File* const_sg_file_t;
 typedef s4u_VM* sg_vm_t;
 typedef const s4u_VM* const_sg_vm_t;
index d3bcd84..39b45cb 100644 (file)
@@ -84,7 +84,7 @@ extern template class XBT_PUBLIC xbt::Extendable<s4u::File>;
 namespace s4u {
 
 /** @brief A simulated file
- *  @addtogroup Plugin_filesystem
+ *  @ingroup plugin_filesystem
  *
  * Used to simulate the time it takes to access to a file, but does not really store any information.
  *
index 2ea809b..7473903 100644 (file)
@@ -181,7 +181,7 @@ public:
  * When adding a route with split-duplex links, you need to specify the direction of the link
  * so SimGrid can know exactly which physical link to insert in the route.
  *
- * For shared/fat-pipe links, use the :cpp:enum:`Direction::NONE` since they don't have
+ * For shared/fat-pipe links, use the :cpp:enumerator:`Direction::NONE` since they don't have
  * the concept of UP/DOWN links.
  * @endrst
  */
index 27d7957..c198186 100644 (file)
@@ -165,8 +165,8 @@ public abstract class Process implements Runnable {
        public native void resume();    
        /** Tests if a process is suspended.
         *
-        * @see #suspend()
-        * @see #resume()
+        * @see suspend()
+        * @see resume()
         */
        public native boolean isSuspended();