From d206d98b5c7c80f0614239ec37a21ebf7c69faa6 Mon Sep 17 00:00:00 2001 From: Martin Quinson Date: Tue, 21 Jul 2015 01:17:16 +0200 Subject: [PATCH] further doxygen cleanups --- src/surf/host_interface.hpp | 32 +++++--------------------------- src/surf/vm_interface.hpp | 13 ++++--------- 2 files changed, 9 insertions(+), 36 deletions(-) diff --git a/src/surf/host_interface.hpp b/src/surf/host_interface.hpp index 5f3f64f0ae..0fd2d15afe 100644 --- a/src/surf/host_interface.hpp +++ b/src/surf/host_interface.hpp @@ -169,12 +169,7 @@ public: */ virtual double getAvailableSpeed(); - /** - * @brief Get the associated Cpu power peak - * - * @return The associated Cpu power peak - * @see Cpu - */ + /** @brief Get the associated Cpu power peak */ virtual double getCurrentPowerPeak(); virtual double getPowerPeakAt(int pstate_index); @@ -182,26 +177,13 @@ public: virtual void setPstate(int pstate_index); virtual int getPstate(); - /** - * @brief Return the storage of corresponding mount point - * - * @param storage The mount point - * @return The corresponding Storage - */ + /** @brief Return the storage of corresponding mount point */ virtual Storage *findStorageOnMountList(const char* storage); - /** - * @brief Get the xbt_dict_t of mount_point: Storage - * - * @return The xbt_dict_t of mount_point: Storage - */ + /** @brief Get the xbt_dict_t of mount_point: Storage */ virtual xbt_dict_t getMountedStorageList(); - /** - * @brief Get the xbt_dynar_t of storages attached to the Host - * - * @return The xbt_dynar_t of Storage names - */ + /** @brief Get the xbt_dynar_t of storages attached to the Host */ virtual xbt_dynar_t getAttachedStorageList(); /** @@ -307,11 +289,7 @@ public: RoutingEdge *p_netElm; Cpu *p_cpu; - /** - * @brief Get the list of virtual machines on the current Host - * - * @return The list of VMs - */ + /** @brief Get the list of virtual machines on the current Host */ xbt_dynar_t getVms(); /* common with vm */ diff --git a/src/surf/vm_interface.hpp b/src/surf/vm_interface.hpp index c050250d70..e15fa81010 100644 --- a/src/surf/vm_interface.hpp +++ b/src/surf/vm_interface.hpp @@ -78,7 +78,7 @@ class VM : public Host, public boost::intrusive::list_base_hook<> { public: /** - * @brief VM constructor + * @brief Constructor * * @param model VMModel associated to this VM * @param name The name of the VM @@ -89,9 +89,7 @@ public: VM(Model *model, const char *name, xbt_dict_t props, RoutingEdge *netElm, Cpu *cpu); - /** - * @brief WdorkstationVM destructor - */ + /** @brief Destructor */ ~VM(); void setState(e_surf_resource_state_t state); @@ -108,11 +106,8 @@ public: /** @brief Restore the VM (Not yet implemented) */ virtual void restore()=0; - /** @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 Migrate the VM to the destination host */ + virtual void migrate(surf_resource_t dest_PM)=0; /** @brief Get the physical machine hosting the VM */ virtual surf_resource_t getPm()=0; -- 2.20.1