Hide some deprecated symbols from doxygen

[simgrid.git] / include / simgrid / s4u / VirtualMachine.hpp

diff --git a/include/simgrid/s4u/VirtualMachine.hpp b/include/simgrid/s4u/VirtualMachine.hpp
index f228203..76e8380 100644 (file)
--- a/include/simgrid/s4u/VirtualMachine.hpp
+++ b/include/simgrid/s4u/VirtualMachine.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2015-2020. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2015-2021. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
@@ -8,6 +8,7 @@
 
 #include <simgrid/forward.h>
 #include <simgrid/s4u/Host.hpp>
+#include <xbt/utility.hpp>
 
 namespace simgrid {
 namespace s4u {
@@ -34,14 +35,18 @@ public:
   VirtualMachine& operator=(VirtualMachine const&) = delete;
 #endif
 
-  enum class state {
+  // enum class State { ... }
+  XBT_DECLARE_ENUM_CLASS(State,
     CREATED, /**< created, but not yet started */
     RUNNING,
     SUSPENDED, /**< Suspend/resume does not involve disk I/O, so we assume there is no transition states. */
     DESTROYED
-  };
+  );
+#ifndef DOXYGEN
+  using state XBT_ATTRIB_DEPRECATED_v332("Please use VirtualMachine::State") = State;
+#endif
 
-  vm::VirtualMachineImpl* get_impl() const { return pimpl_vm_; }
+  vm::VirtualMachineImpl* get_vm_impl() const { return pimpl_vm_; }
   void start();
   void suspend();
   void resume();
@@ -54,7 +59,7 @@ public:
   VirtualMachine* set_ramsize(size_t ramsize);
   VirtualMachine* set_bound(double bound);
 
-  VirtualMachine::state get_state() const;
+  State get_state() const;
   static xbt::signal<void(VirtualMachine const&)> on_start;
   static xbt::signal<void(VirtualMachine const&)> on_started;
   static xbt::signal<void(VirtualMachine const&)> on_shutdown;