From 3c0313c114fac7a4c5e0e4f9bdc2f48b4e4ddbff Mon Sep 17 00:00:00 2001 From: Martin Quinson Date: Mon, 7 Dec 2015 17:38:02 +0100 Subject: [PATCH] some documentation fixes --- src/surf/cpu_interface.hpp | 10 ++++++---- src/surf/network_interface.hpp | 2 +- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/src/surf/cpu_interface.hpp b/src/surf/cpu_interface.hpp index 385164f704..4e9e97f09d 100644 --- a/src/surf/cpu_interface.hpp +++ b/src/surf/cpu_interface.hpp @@ -106,12 +106,13 @@ public: * @param props Dictionary of properties associated to this Cpu * @param constraint The lmm constraint associated to this Cpu if it is part of a LMM component * @param core The number of core of this Cpu - * @param speedPeak The speed peak of this Cpu - * @param speedScale The speed scale of this Cpu + * @param speedPeak The speed peak of this Cpu in flops (max speed) + * @param speedScale The speed scale of this Cpu in [0;1] (available amount) + * @param stateInitial whether it is created running or crashed */ Cpu(Model *model, const char *name, xbt_dict_t props, lmm_constraint_t constraint, int core, double speedPeak, double speedScale, - e_surf_resource_state_t stateInitial); + e_surf_resource_state_t stateInitial); /** * @brief Cpu constructor @@ -122,10 +123,11 @@ public: * @param core The number of core of this Cpu * @param speedPeak The speed peak of this Cpu in flops (max speed) * @param speedScale The speed scale of this Cpu in [0;1] (available amount) + * @param stateInitial whether it is created running or crashed */ Cpu(Model *model, const char *name, xbt_dict_t props, int core, double speedPeak, double speedScale, - e_surf_resource_state_t stateInitial); + e_surf_resource_state_t stateInitial); Cpu(Model *model, const char *name, xbt_dict_t props, lmm_constraint_t constraint, int core, double speedPeak, double speedScale); diff --git a/src/surf/network_interface.hpp b/src/surf/network_interface.hpp index 5b12fc9912..d1f327dd34 100644 --- a/src/surf/network_interface.hpp +++ b/src/surf/network_interface.hpp @@ -217,7 +217,7 @@ public: /** @brief Update the latency in seconds of current Link */ virtual void updateLatency(double value, double date=surf_get_clock())=0; - /** @brief The sharing policy is a @e_surf_link_sharing_policy_t (0: FATPIPE, 1: SHARED, 2: FULLDUPLEX) */ + /** @brief The sharing policy is a @{link #e_surf_link_sharing_policy_t} (0: FATPIPE, 1: SHARED, 2: FULLDUPLEX) */ virtual int sharingPolicy(); /** @brief Check if the Link is used */ -- 2.20.1