From 6d3f12ae629969d1ede04070ba244377e3cf434d Mon Sep 17 00:00:00 2001 From: Arnaud Giersch Date: Thu, 21 Nov 2013 11:03:09 +0100 Subject: [PATCH] Fix doxygen/javadoc warnings. --- src/bindings/java/org/simgrid/msg/VM.java | 15 +++++++-------- src/msg/msg_host.c | 9 +++++---- src/msg/msg_task.c | 2 +- src/msg/msg_vm.c | 10 +++++----- src/simix/smx_user.c | 2 ++ 5 files changed, 20 insertions(+), 18 deletions(-) diff --git a/src/bindings/java/org/simgrid/msg/VM.java b/src/bindings/java/org/simgrid/msg/VM.java index 7b7340492c..8d4b1347a0 100644 --- a/src/bindings/java/org/simgrid/msg/VM.java +++ b/src/bindings/java/org/simgrid/msg/VM.java @@ -34,17 +34,16 @@ public class VM extends Host{ /** * Create a VM - * @param host, Host node - * @param name, name of the machine - * @param nCore, number of core - * @param ramSize, size of the RAM that should be allocated (in MBytes) + * @param host Host node + * @param name name of the machine + * @param nCore number of core + * @param ramSize size of the RAM that should be allocated (in MBytes) * @param netCap (not used for the moment) * @param diskPath (not used for the moment) * @param diskSize (not used for the moment) * @param migNetSpeed (network bandwith allocated for migrations in MB/s, if you don't know put zero ;)) * @param dpIntensity (dirty page percentage according to migNetSpeed, [0-100], if you don't know put zero ;)) */ - public VM(Host host, String name, int nCore, int ramSize, int netCap, String diskPath, int diskSize, int migNetSpeed, int dpIntensity){ super(); @@ -117,8 +116,8 @@ public class VM extends Host{ /** * Natively implemented method create the VM. - * @param nCore, number of core - * @param ramSize, size of the RAM that should be allocated (in MB) + * @param nCore number of core + * @param ramSize size of the RAM that should be allocated (in MB) * @param netCap (not used for the moment) * @param diskPath (not used for the moment) * @param diskSize (not used for the moment) @@ -131,7 +130,7 @@ public class VM extends Host{ /** * Bound the VM to a certain % of its vcpu capability (e.g. 75% of vm.getSpeed()) - * @param load, percentage (between [0,100] + * @param load percentage (between [0,100] */ public native void setBound(int load); diff --git a/src/msg/msg_host.c b/src/msg/msg_host.c index 9e45fce990..8d6a6be3df 100644 --- a/src/msg/msg_host.c +++ b/src/msg/msg_host.c @@ -318,15 +318,16 @@ int MSG_host_is_avail(msg_host_t host) xbt_assert((host != NULL), "Invalid parameters (host is NULL)"); return (simcall_host_get_state(host)); } + /** \ingroup m_host_management * \brief Set the parameters of a given host * * \param host a host * \param params a prameter object */ -void MSG_host_set_params(msg_host_t ind_pm, ws_params_t params) +void MSG_host_set_params(msg_host_t host, ws_params_t params) { - simcall_host_set_params(ind_pm, params); + simcall_host_set_params(host, params); } /** \ingroup m_host_management @@ -335,9 +336,9 @@ void MSG_host_set_params(msg_host_t ind_pm, ws_params_t params) * \param host a host * \param params a prameter object */ -void MSG_host_get_params(msg_host_t ind_pm, ws_params_t params) +void MSG_host_get_params(msg_host_t host, ws_params_t params) { - simcall_host_get_params(ind_pm, params); + simcall_host_get_params(host, params); } /** \ingroup m_host_management diff --git a/src/msg/msg_task.c b/src/msg/msg_task.c index aee793c7d1..02d9134478 100644 --- a/src/msg/msg_task.c +++ b/src/msg/msg_task.c @@ -480,7 +480,7 @@ void MSG_task_set_bound(msg_task_t task, double bound) * * Usage: * 0. Define a host with multiple cores. - * + * \ * * 1. Pin a given task to the first CPU core of a host. * MSG_task_set_affinity(task, pm0, 0x01); diff --git a/src/msg/msg_vm.c b/src/msg/msg_vm.c index 72d331b67a..454a02e27b 100644 --- a/src/msg/msg_vm.c +++ b/src/msg/msg_vm.c @@ -58,7 +58,7 @@ xbt_dict_t MSG_vm_get_properties(msg_vm_t vm) /** \ingroup m_host_management * \brief Change the value of a given host property * - * \param host a host + * \param vm a vm * \param name a property name * \param value what to change the property to * \param free_ctn the freeing function to use to kill the value on need @@ -1244,11 +1244,11 @@ msg_host_t MSG_vm_get_pm(msg_vm_t vm) * For example, * On PM0, there are Task1 and VM0. * On VM0, there is Task2. - * Now we bound 75% to Task1@PM0 and bound 25% to Task2@VM0. + * Now we bound 75% to Task1\@PM0 and bound 25% to Task2\@VM0. * Then, - * Task1@PM0 gets 50%. - * Task2@VM0 gets 25%. - * This is NOT 75% for Task1@PM0 and 25% for Task2@VM0, respectively. + * Task1\@PM0 gets 50%. + * Task2\@VM0 gets 25%. + * This is NOT 75% for Task1\@PM0 and 25% for Task2\@VM0, respectively. * * This is because a VM has the dummy CPU action in the PM layer. Putting a * task on the VM does not affect the bound of the dummy CPU action. The bound diff --git a/src/simix/smx_user.c b/src/simix/smx_user.c index d0aa664135..929a8e09d5 100644 --- a/src/simix/smx_user.c +++ b/src/simix/smx_user.c @@ -253,6 +253,8 @@ double simcall_host_get_consumed_energy(smx_host_t host) * \param host SIMIX host where the action will be executed * \param computation_amount amount Computation amount (in bytes) * \param priority computation priority + * \param bound + * \param affinity_mask * \return A new SIMIX execution action */ smx_action_t simcall_host_execute(const char *name, smx_host_t host, -- 2.20.1