From 5749413e83be55dd188d8ea755b55b4da4a11f35 Mon Sep 17 00:00:00 2001 From: Arnaud Giersch Date: Fri, 9 Jul 2021 18:32:49 +0200 Subject: [PATCH] Fix another bunch of warnings in doc generation. --- docs/source/Plugins.rst | 3 - docs/source/app_msg.rst | 2 + docs/source/conf.py | 57 ++++++++++++++----- include/simgrid/forward.h | 4 +- include/simgrid/plugins/file_system.h | 2 +- include/simgrid/s4u/Link.hpp | 2 +- .../java/org/simgrid/msg/Process.java | 4 +- 7 files changed, 51 insertions(+), 23 deletions(-) diff --git a/docs/source/Plugins.rst b/docs/source/Plugins.rst index 5bc1614717..1ef1475df9 100644 --- a/docs/source/Plugins.rst +++ b/docs/source/Plugins.rst @@ -152,8 +152,5 @@ File System .. doxygengroup:: plugin_filesystem -.. doxygentypedef:: sg_file_t -.. doxygentypedef:: const_sg_file_t .. LocalWords: SimGrid - diff --git a/docs/source/app_msg.rst b/docs/source/app_msg.rst index e3b0160552..082e64b018 100644 --- a/docs/source/app_msg.rst +++ b/docs/source/app_msg.rst @@ -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 ************* diff --git a/docs/source/conf.py b/docs/source/conf.py index 89b8cb2016..171ae1b131 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -71,8 +71,8 @@ nitpick_ignore = [ ('cpp:identifier', 'boost::intrusive_ptr'), ('cpp:identifier', 'boost::intrusive_ptr'), ('cpp:identifier', 'boost::intrusive_ptr'), - ('cpp:identifier', 'boost::intrusive_ptr'), ('cpp:identifier', 'boost::intrusive_ptr'), + ('cpp:identifier', 'boost::intrusive_ptr'), ('cpp:identifier', 'boost::intrusive_ptr'), ('cpp:identifier', 'boost::intrusive_ptr'), ('cpp:identifier', 'boost::intrusive_ptr'), @@ -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'), - ('cpp:identifier', 'simgrid::s4u::Activity_T'), - ('cpp:identifier', 'simgrid::s4u::Activity_T'), - ('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'), + ('cpp:identifier', 'simgrid::s4u::Activity_T'), + ('cpp:identifier', 'simgrid::s4u::Activity_T'), + ('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'), + ('cpp:identifier', 'xbt::Extendable'), + ('cpp:identifier', 'xbt::Extendable'), + ('cpp:identifier', 'xbt::Extendable'), + ('cpp:identifier', 'xbt::Extendable'), ('cpp:identifier', 'xbt::signal'), + ('cpp:identifier', 'xbt::signal'), + ('cpp:identifier', 'xbt::signal'), + ('cpp:identifier', 'xbt::signal'), + ('cpp:identifier', 'xbt::signal'), + ('cpp:identifier', 'xbt::signal'), + ('cpp:identifier', 'xbt::signal'), + ('cpp:identifier', 'xbt::signal'), + ('cpp:identifier', 'xbt::signal'), + ('cpp:identifier', 'xbt::signal'), + ('cpp:identifier', 'xbt::signal'), + ('cpp:identifier', 'xbt::signal'), + ('cpp:identifier', 'xbt::signal'), + ('cpp:identifier', 'xbt::signal'), + ('cpp:identifier', 'xbt::signal'), + ('cpp:identifier', 'xbt::signal'), + ('cpp:identifier', 'xbt::signal'), + ('cpp:identifier', 'xbt::signal'), ('cpp:identifier', 'xbt::signal'), ('cpp:identifier', 'xbt::string'), ] diff --git a/include/simgrid/forward.h b/include/simgrid/forward.h index bbfbd1c756..41ca22c811 100644 --- a/include/simgrid/forward.h +++ b/include/simgrid/forward.h @@ -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; diff --git a/include/simgrid/plugins/file_system.h b/include/simgrid/plugins/file_system.h index d3bcd84005..39b45cb11c 100644 --- a/include/simgrid/plugins/file_system.h +++ b/include/simgrid/plugins/file_system.h @@ -84,7 +84,7 @@ extern template class XBT_PUBLIC xbt::Extendable; 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. * diff --git a/include/simgrid/s4u/Link.hpp b/include/simgrid/s4u/Link.hpp index 2ea809bc01..747390349c 100644 --- a/include/simgrid/s4u/Link.hpp +++ b/include/simgrid/s4u/Link.hpp @@ -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 */ diff --git a/src/bindings/java/org/simgrid/msg/Process.java b/src/bindings/java/org/simgrid/msg/Process.java index 27d7957af4..c198186c6f 100644 --- a/src/bindings/java/org/simgrid/msg/Process.java +++ b/src/bindings/java/org/simgrid/msg/Process.java @@ -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(); -- 2.20.1