From 46f56109cc64b4b1618f7bbdc2762d0c8b9f5100 Mon Sep 17 00:00:00 2001 From: Martin Quinson Date: Tue, 25 Dec 2018 18:52:08 +0100 Subject: [PATCH] hide deprecated methods from doxygen --- include/simgrid/s4u/ConditionVariable.hpp | 2 ++ include/simgrid/s4u/Engine.hpp | 4 ++++ include/simgrid/s4u/Host.hpp | 4 +++- include/simgrid/s4u/Mailbox.hpp | 3 +++ include/simgrid/s4u/Mutex.hpp | 2 ++ include/simgrid/s4u/NetZone.hpp | 2 ++ include/simgrid/s4u/Storage.hpp | 2 ++ include/simgrid/s4u/VirtualMachine.hpp | 2 ++ 8 files changed, 20 insertions(+), 1 deletion(-) diff --git a/include/simgrid/s4u/ConditionVariable.hpp b/include/simgrid/s4u/ConditionVariable.hpp index 12e0be189a..05f5c411e5 100644 --- a/include/simgrid/s4u/ConditionVariable.hpp +++ b/include/simgrid/s4u/ConditionVariable.hpp @@ -36,11 +36,13 @@ public: static ConditionVariablePtr create(); +#ifndef DOXYGEN /** @deprecated See Comm::get_mailbox() */ XBT_ATTRIB_DEPRECATED_v323("Please use Comm::get_mailbox()") ConditionVariablePtr createConditionVariable() { return create(); } +#endif // Wait functions without time: diff --git a/include/simgrid/s4u/Engine.hpp b/include/simgrid/s4u/Engine.hpp index 7a06b5175d..b7616a407a 100644 --- a/include/simgrid/s4u/Engine.hpp +++ b/include/simgrid/s4u/Engine.hpp @@ -159,6 +159,7 @@ private: static s4u::Engine* instance_; //////////////// Deprecated functions +#ifndef DOXYGEN public: /** @deprecated See Engine::load_platform() */ XBT_ATTRIB_DEPRECATED_v323("Please use Engine::load_platform()") void loadPlatform(std::string platf) @@ -278,6 +279,7 @@ public: } /** @deprecated See Engine::set_config() */ XBT_ATTRIB_DEPRECATED_v323("Please use Engine::set_config()") void setConfig(std::string str) { set_config(str); } +#endif }; /** Callback fired when the platform is created (ie, the xml file parsed), @@ -297,6 +299,7 @@ extern XBT_PUBLIC xbt::signal on_time_advance; /** Callback fired when the time cannot advance because of inter-actors deadlock */ extern XBT_PUBLIC xbt::signal on_deadlock; +#ifndef DOXYGEN /* Internal use only, no need to expose it */ template XBT_PRIVATE void get_filtered_netzones_recursive(s4u::NetZone* current, std::vector* whereto) { static_assert(std::is_base_of::value, @@ -307,6 +310,7 @@ template XBT_PRIVATE void get_filtered_netzones_recursive(s4u::NetZone whereto->push_back(dynamic_cast(elem->get_impl())); } } +#endif } } // namespace simgrid::s4u diff --git a/include/simgrid/s4u/Host.hpp b/include/simgrid/s4u/Host.hpp index ac19803522..30797f2302 100644 --- a/include/simgrid/s4u/Host.hpp +++ b/include/simgrid/s4u/Host.hpp @@ -127,22 +127,24 @@ public: { return get_pstate_speed(pstate_index); } -#endif std::vector get_attached_storages() const; XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_attached_storages() instead.") void getAttachedStorages( std::vector* storages); +#endif /** Get an associative list [mount point]->[Storage] of all local mount points. * * This is defined in the platform file, and cannot be modified programatically (yet). */ std::unordered_map const& get_mounted_storages(); +#ifndef DOXYGEN /** @deprecated See Host::get_mounted_storages() */ XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_mounted_storages() instead.") std::unordered_map const& getMountedStorages() { return get_mounted_storages(); } +#endif void route_to(Host* dest, std::vector& links, double* latency); void route_to(Host* dest, std::vector& links, double* latency); diff --git a/include/simgrid/s4u/Mailbox.hpp b/include/simgrid/s4u/Mailbox.hpp index 630d238aab..6f595450c2 100644 --- a/include/simgrid/s4u/Mailbox.hpp +++ b/include/simgrid/s4u/Mailbox.hpp @@ -27,6 +27,7 @@ class XBT_PUBLIC Mailbox { friend void intrusive_ptr_add_ref(Mailbox*) {} /** private function to manage the mailboxes' lifetime (see @ref s4u_raii) */ friend void intrusive_ptr_release(Mailbox*) {} + public: /** private function, do not use. FIXME: make me protected */ kernel::activity::MailboxImpl* get_impl() { return pimpl_; } @@ -97,6 +98,7 @@ public: void* get(double timeout); // Deprecated functions +#ifndef DOXYGEN /** @deprecated Mailbox::set_receiver() */ XBT_ATTRIB_DEPRECATED_v323("Please use Mailbox::set_receiver()") void setReceiver(ActorPtr actor) { @@ -126,6 +128,7 @@ public: { return by_name(name); } +#endif }; }} // namespace simgrid::s4u diff --git a/include/simgrid/s4u/Mutex.hpp b/include/simgrid/s4u/Mutex.hpp index 4c8b9207fa..5ad1bbe6c9 100644 --- a/include/simgrid/s4u/Mutex.hpp +++ b/include/simgrid/s4u/Mutex.hpp @@ -51,9 +51,11 @@ public: void unlock(); bool try_lock(); +#ifndef DOXYGEN // deprecated /** @deprecated Mutex::create() */ XBT_ATTRIB_DEPRECATED_v323("Please use Mutex::create()") static MutexPtr createMutex() { return create(); } +#endif }; }} // namespace simgrid::s4u diff --git a/include/simgrid/s4u/NetZone.hpp b/include/simgrid/s4u/NetZone.hpp index 8156699c38..552ff1ca55 100644 --- a/include/simgrid/s4u/NetZone.hpp +++ b/include/simgrid/s4u/NetZone.hpp @@ -74,6 +74,7 @@ public: static simgrid::xbt::signal on_creation; static simgrid::xbt::signal on_seal; +#ifndef DOXYGEN // Deprecation wrappers /** @deprecated NetZone::get_father() */ XBT_ATTRIB_DEPRECATED_v323("Please use NetZone::get_father()") NetZone* getFather() { return get_father(); } @@ -130,6 +131,7 @@ public: res->push_back(child); return res; } +#endif }; } }; // Namespace simgrid::s4u diff --git a/include/simgrid/s4u/Storage.hpp b/include/simgrid/s4u/Storage.hpp index 7559611c7f..9a65fd349b 100644 --- a/include/simgrid/s4u/Storage.hpp +++ b/include/simgrid/s4u/Storage.hpp @@ -73,6 +73,7 @@ public: surf::StorageImpl* get_impl() { return pimpl_; } // Deprecated functions +#ifndef DOXYGEN /** @deprecated Storage::by_name() */ XBT_ATTRIB_DEPRECATED_v323("Please use Storage::by_name()") Storage* byName(std::string name) { @@ -109,6 +110,7 @@ public: XBT_ATTRIB_DEPRECATED_v323("Please use Storage::set_data()") void setUserdata(void* data) { set_data(data); } /** @deprecated Storage::get_data() */ XBT_ATTRIB_DEPRECATED_v323("Please use Storage::get_data()") void* getUserdata() { return get_data(); } +#endif private: Host* attached_to_ = nullptr; diff --git a/include/simgrid/s4u/VirtualMachine.hpp b/include/simgrid/s4u/VirtualMachine.hpp index 69221c8b78..d2410febf3 100644 --- a/include/simgrid/s4u/VirtualMachine.hpp +++ b/include/simgrid/s4u/VirtualMachine.hpp @@ -60,6 +60,7 @@ public: static simgrid::xbt::signal on_migration_start; static simgrid::xbt::signal on_migration_end; +#ifndef DOXYGEN // Deprecated methods /** @deprecated See VirtualMachine::get_state() */ XBT_ATTRIB_DEPRECATED_v323("Please use VirtualMachine::get_state()") VirtualMachine::state getState() @@ -84,6 +85,7 @@ public: } /** @deprecated See VirtualMachine::set_bound() */ XBT_ATTRIB_DEPRECATED_v323("Please use VirtualMachine::set_bound()") void setBound(double bound) { set_bound(bound); } +#endif }; } } // namespace simgrid::s4u -- 2.20.1