cosmetics in doxygen comments

[simgrid.git] / src / surf / vm_interface.hpp

diff --git a/src/surf/vm_interface.hpp b/src/surf/vm_interface.hpp
index a8ddce8..e221713 100644 (file)
--- a/src/surf/vm_interface.hpp
+++ b/src/surf/vm_interface.hpp
@@ -17,35 +17,26 @@
  ***********/
 
 class VMModel;
-typedef VMModel *VMModelPtr;
-
 class VM;
-typedef VM *VMPtr;
-
-class VMLmm;
-typedef VMLmm *VMLmmPtr;
 
 /*************
  * Callbacks *
  *************/
 
 /** @ingroup SURF_callbacks
- * @brief Callbacks handler which emit the callbacks after VM creation *
- * @details Callback functions have the following signature: `void(VMPtr)`
+ * @brief Callbacks fired after VM creation. Signature: `void(VM*)`
  */
-extern surf_callback(void, VMPtr) VMCreatedCallbacks;
+extern surf_callback(void, VM*) VMCreatedCallbacks;
 
 /** @ingroup SURF_callbacks
- * @brief Callbacks handler which emit the callbacks after VM destruction *
- * @details Callback functions have the following signature: `void(VMPtr)`
+ * @brief Callbacks fired after VM destruction. Signature: `void(VM*)`
  */
-extern surf_callback(void, VMPtr) VMDestructedCallbacks;
+extern surf_callback(void, VM*) VMDestructedCallbacks;
 
 /** @ingroup SURF_callbacks
- * @brief Callbacks handler which emit the callbacks after VM State changed *
- * @details Callback functions have the following signature: `void(VMActionPtr)`
+ * @brief Callbacks after VM State changes. Signature: `void(VMAction*)`
  */
-extern surf_callback(void, VMPtr) VMStateChangedCallbacks;
+extern surf_callback(void, VM*) VMStateChangedCallbacks;
 
 /*********
  * Model *
@@ -59,7 +50,7 @@ public:
   VMModel();
   ~VMModel(){};
 
-  HostPtr createHost(const char *name){DIE_IMPOSSIBLE;}
+  Host *createHost(const char *name){DIE_IMPOSSIBLE;}
 
   /**
    * @brief Create a new VM
@@ -68,12 +59,10 @@ public:
    * @param host_PM The real machine hosting the VM
    *
    */
-  virtual VMPtr createVM(const char *name, surf_resource_t host_PM)=0;
+  virtual VM *createVM(const char *name, surf_resource_t host_PM)=0;
   void adjustWeightOfDummyCpuActions() {};
 
-  typedef boost::intrusive::list<VM,
-                                 boost::intrusive::constant_time_size<false> >
-          vm_list_t;
+  typedef boost::intrusive::list<VM, boost::intrusive::constant_time_size<false> > vm_list_t;
   static vm_list_t ws_vms;
 };
 
@@ -97,8 +86,8 @@ public:
    * @param netElm The RoutingEdge associated to this VM
    * @param cpu The Cpu associated to this VM
    */
-  VM(ModelPtr model, const char *name, xbt_dict_t props,
-                       RoutingEdgePtr netElm, CpuPtr cpu);
+  VM(Model *model, const char *name, xbt_dict_t props,
+                       RoutingEdge *netElm, Cpu *cpu);
 
   /**
    * @brief WdorkstationVM destructor
@@ -107,45 +96,33 @@ public:
 
   void setState(e_surf_resource_state_t state);
 
-  /**
-   * @brief Suspend the VM
-   */
+  /** @brief Suspend the VM */
   virtual void suspend()=0;
 
-  /**
-   * @brief Resume the VM
-   */
+  /** @brief Resume the VM */
   virtual void resume()=0;
 
-  /**
-   * @brief Save the VM (Not yet implemented)
-   */
+  /** @brief Save the VM (Not yet implemented) */
   virtual void save()=0;
 
-  /**
-   * @brief Restore the VM (Not yet implemented)
-   */
+  /** @brief Restore the VM (Not yet implemented) */
   virtual void restore()=0;
 
-  /**
-   * @brief Migrate the VM to the destination host
+  /** @brief Migrate the VM to the destination host
    *
    * @param ind_vm_ws_dest The destination host
    */
   virtual void migrate(surf_resource_t ind_vm_ws_dest)=0;
 
-  /**
-   * @brief Get the physical machine hosting the VM
-   * @return The physical machine hosting the VM
-   */
+  /** @brief Get the physical machine hosting the VM */
   virtual surf_resource_t getPm()=0;
 
   virtual void setBound(double bound)=0;
-  virtual void setAffinity(CpuPtr cpu, unsigned long mask)=0;
+  virtual void setAffinity(Cpu *cpu, unsigned long mask)=0;
 
   /* The vm object of the lower layer */
-  CpuActionPtr p_action;
-  HostPtr p_subWs;  // Pointer to the ''host'' OS
+  CpuAction *p_action;
+  Host *p_subWs;  // Pointer to the ''host'' OS
   e_surf_vm_state_t p_currentState;
 };