X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/c07e240c1c2241cbcc39afa7059a738aff587eb5..bad14d23aa8bca6a7a96a68f8e64ea74ee7b20b0:/docs/find-missing.ignore diff --git a/docs/find-missing.ignore b/docs/find-missing.ignore index 40a3006597..e2ec4edbd1 100644 --- a/docs/find-missing.ignore +++ b/docs/find-missing.ignore @@ -1,7 +1,34 @@ This file lists the symbols ignored in the documentation. -It follows the RST syntact but is completely ignored by sphinx. +It follows the RST syntax but is completely ignored by sphinx. It is only used by find-missing, that will not report any definition linked here as missing. +# These ones trigger a bug in autodoxy, that get confused with the const in the function parameter +# So I document them manually in the rst for now. Shame, weak. +.. autodoxyvar:: simgrid::s4u::Link::on_communicate +.. autodoxyvar:: simgrid::s4u::Actor::on_host_change +.. autodoxyvar:: simgrid::s4u::Exec::on_completion +.. autodoxyvar:: simgrid::s4u::Exec::on_start + +# This is a bug in find-missing, as these symbols are actually documented +.. autodoxymethod:: simgrid::s4u::Host::route_to(const Host *dest, std::vector< Link * > &links, double *latency) +.. autodoxymethod:: simgrid::s4u::Host::route_to(const Host *dest, std::vector< kernel::resource::LinkImpl * > &links, double *latency) + +# The fact that actors can return an int is a legacy behavior for MSG +.. autodoxymethod:: simgrid::s4u::Engine::register_default(const kernel::actor::ActorCodeFactory &factory) +.. autodoxymethod:: simgrid::s4u::Engine::register_default(int(*code)(int, char **)) +.. autodoxymethod:: simgrid::s4u::Engine::register_function(const std::string &name, const kernel::actor::ActorCodeFactory &factory) +.. autodoxymethod:: simgrid::s4u::Engine::register_function(const std::string &name, int(*code)(int, char **)) + + +# These could be hidden as private things, eg in s4u_Exec.cpp +.. autodoxymethod:: simgrid::s4u::ExecPar::get_remaining() +.. autodoxymethod:: simgrid::s4u::ExecPar::get_remaining_ratio() +.. autodoxymethod:: simgrid::s4u::ExecPar::start() +.. autodoxymethod:: simgrid::s4u::ExecSeq::get_remaining() +.. autodoxymethod:: simgrid::s4u::ExecSeq::get_remaining_ratio() +.. autodoxymethod:: simgrid::s4u::ExecSeq::set_host(Host *host) +.. autodoxymethod:: simgrid::s4u::ExecSeq::start() + # I don't plan to document MSG in the new way. .. autodoxymethod:: ::MSG_barrier_destroy(const_sg_bar_t bar) .. autodoxymethod:: ::MSG_barrier_init(unsigned int count) @@ -180,6 +207,14 @@ member ::msg_error_t is of kind enum # These should not be public .. autodoxymethod:: simgrid::s4u::Link::get_impl() +.. autodoxymethod:: simgrid::s4u::NetZone::get_impl() +.. autodoxymethod:: simgrid::s4u::VirtualMachine::get_impl() +.. autodoxymethod:: simgrid::s4u::Activity::get_impl() +.. autodoxymethod:: simgrid::s4u::Comm::~Comm() +.. autodoxymethod:: simgrid::s4u::Exec::~Exec() +.. autodoxymethod:: simgrid::s4u::ExecPar::~ExecPar() +.. autodoxymethod:: simgrid::s4u::ExecSeq::~ExecSeq() +.. autodoxymethod:: simgrid::s4u::Io::~Io() # These ones are a bug of Doxygen, that parse them as variables instead of types. # So we don't use this bogus parse result, but go directly for cpp:type directives in app_s4u.rst