Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
doxygen: better handling of deprecated symbols
[simgrid.git] / include / simgrid / s4u / Storage.hpp
index 3893123..bd6b092 100644 (file)
@@ -20,6 +20,7 @@ extern template class XBT_PUBLIC Extendable<simgrid::s4u::Storage>;
 }
 namespace s4u {
 
+/** @deprecated Engine::get_all_storages() */
 XBT_ATTRIB_DEPRECATED_v322("Please use Engine::get_all_storages()") XBT_PUBLIC void getStorageList(std::map<std::string, Storage*>* whereTo);
 
 class XBT_PUBLIC Storage : public simgrid::xbt::Extendable<Storage> {
@@ -65,14 +66,20 @@ public:
   surf::StorageImpl* get_impl() { return pimpl_; }
 
   // Deprecated functions
+  /** @deprecated Storage::by_name() */
   XBT_ATTRIB_DEPRECATED_v323("Please use Storage::by_name()") Storage* byName(std::string name)
   {
     return by_name(name);
   }
+  /** @deprecated Storage::get_name() */
   XBT_ATTRIB_DEPRECATED_v323("Please use Storage::get_name()") std::string const& getName() const { return get_name(); }
+  /** @deprecated Storage::get_cname() */
   XBT_ATTRIB_DEPRECATED_v323("Please use Storage::get_cname()") const char* getCname() const { return get_cname(); }
+  /** @deprecated Storage::get_type() */
   XBT_ATTRIB_DEPRECATED_v323("Please use Storage::get_type()") const char* getType() { return get_type(); }
+  /** @deprecated Storage::get_host() */
   XBT_ATTRIB_DEPRECATED_v323("Please use Storage::get_host()") Host* getHost() { return get_host(); }
+  /** @deprecated Storage::get_properties() */
   XBT_ATTRIB_DEPRECATED_v323("Please use Storage::get_properties()") std::map<std::string, std::string>* getProperties()
   {
     std::map<std::string, std::string>* res             = new std::map<std::string, std::string>();
@@ -81,15 +88,19 @@ public:
       res->insert(kv);
     return res;
   }
+  /** @deprecated Storage::get_property() */
   XBT_ATTRIB_DEPRECATED_v323("Please use Storage::get_property()") const char* getProperty(const char* key)
   {
     return get_property(key);
   }
+  /** @deprecated Storage::set_property() */
   XBT_ATTRIB_DEPRECATED_v323("Please use Storage::set_property()") void setProperty(std::string key, std::string value)
   {
     set_property(key, value);
   }
+  /** @deprecated Storage::set_data() */
   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(); }
 
 private: