docs/find-missing.ignore

   1 This file lists the symbols ignored in the documentation.
   2 It follows the RST syntax but is completely ignored by sphinx.
   3 It is only used by find-missing, that will not report any definition linked here as missing.
   4
   5 # This is a bug in find-missing, as these symbols are actually documented
   6 .. doxygenTODOfunction:: simgrid::s4u::Host::route_to(const Host *dest, std::vector< Link * > &links, double *latency)
   7 .. doxygenTODOfunction:: simgrid::s4u::Host::route_to(const Host *dest, std::vector< kernel::resource::LinkImpl * > &links, double *latency)
   8
   9 # The fact that actors can return an int is a legacy behavior for MSG
  10 .. doxygenTODOfunction:: simgrid::s4u::Engine::register_default(const kernel::actor::ActorCodeFactory &factory)
  11 .. doxygenTODOfunction:: simgrid::s4u::Engine::register_default(int(*code)(int, char **))
  12 .. doxygenTODOfunction:: simgrid::s4u::Engine::register_function(const std::string &name, const kernel::actor::ActorCodeFactory &factory)
  13 .. doxygenTODOfunction:: simgrid::s4u::Engine::register_function(const std::string &name, int(*code)(int, char **))
  14
  15 # These should not be public
  16 .. doxygenfunction:: simgrid::s4u::Link::get_impl()
  17 .. doxygenfunction:: simgrid::s4u::NetZone::get_impl()
  18 .. doxygenfunction:: simgrid::s4u::VirtualMachine::get_vm_impl()
  19 .. doxygenfunction:: simgrid::s4u::Activity::get_impl()
  20 .. doxygenfunction:: simgrid::s4u::Comm::~Comm()
  21 .. doxygenfunction:: simgrid::s4u::Exec::~Exec()
  22 .. doxygenfunction:: simgrid::s4u::Io::~Io()
  23
  24 # These are used to make the C++ objects visible from the C world
  25 .. doxygentypedef:: s4u_Actor
  26 .. doxygentypedef:: s4u_Barrier
  27 .. doxygentypedef:: s4u_Comm
  28 .. doxygentypedef:: s4u_ConditionVariable
  29 .. doxygentypedef:: s4u_Disk
  30 .. doxygentypedef:: s4u_Exec
  31 .. doxygentypedef:: s4u_File
  32 .. doxygentypedef:: s4u_Host
  33 .. doxygentypedef:: s4u_Link
  34 .. doxygentypedef:: s4u_Mailbox
  35 .. doxygentypedef:: s4u_Mutex
  36 .. doxygentypedef:: s4u_NetZone
  37 .. doxygentypedef:: s4u_Semaphore
  38 .. doxygentypedef:: s4u_VM