Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Fix doxygen warnings.
authorArnaud Giersch <arnaud.giersch@iut-bm.univ-fcomte.fr>
Thu, 23 Jan 2014 08:30:14 +0000 (09:30 +0100)
committerArnaud Giersch <arnaud.giersch@iut-bm.univ-fcomte.fr>
Thu, 23 Jan 2014 08:30:14 +0000 (09:30 +0100)
doc/doxygen/module-surf.doc
include/simgrid/platf.h
src/include/surf/surf.h
src/msg/msg_io.c
src/surf/cpu_interface.hpp
src/surf/network_interface.hpp
src/surf/storage_interface.hpp
src/surf/surf_interface.hpp
src/surf/vm_workstation_interface.hpp
src/surf/workstation_interface.hpp

index 0ebc5fa..89b146a 100644 (file)
@@ -7,7 +7,7 @@
    - \ref SURF_resources
    - \ref SURF_build_api
    - \ref SURF_interface
-   - \ref SURF_routing
+   - \ref SURF_routing_interface
    - \ref SURF_cpu_interface
    - \ref SURF_network_interface
    - \ref SURF_storage_interface
index d894607..9ba2421 100644 (file)
@@ -1,6 +1,6 @@
 /* platf.h - Public interface to the SimGrid platforms                      */
 
-/* Copyright (c) 2004-2013. The SimGrid Team.
+/* Copyright (c) 2004-2014. The SimGrid Team.
  * All rights reserved.                                                     */
 
 /* This program is free software; you can redistribute it and/or modify it
@@ -89,7 +89,9 @@ typedef xbt_dictelm_t sg_storage_t;
 static inline char* sg_storage_name(sg_storage_t storage) {
   return storage->key;
 }
-/* Type for any simgrid size */
+/** @ingroup m_datatypes_management_details
+ * @brief Type for any simgrid size
+ */
 typedef unsigned long long sg_size_t;
 
 /*
index 162e610..1e3c36c 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2004-2013. The SimGrid Team.
+/* Copyright (c) 2004-2014. The SimGrid Team.
  * All rights reserved.                                                     */
 
 /* This program is free software; you can redistribute it and/or modify it
@@ -571,7 +571,7 @@ XBT_PUBLIC(void) surf_vm_workstation_set_bound(surf_resource_t resource, double
  * 
  * @param resource [description]
  * @param cpu [description]
- * @param long [description]
+ * @param mask [description]
  */
 XBT_PUBLIC(void) surf_vm_workstation_set_affinity(surf_resource_t resource, surf_resource_t cpu, unsigned long mask);
 
@@ -598,7 +598,7 @@ XBT_PUBLIC(surf_action_t) surf_cpu_sleep(surf_resource_t cpu, double duration);
  * @brief Get the workstation power peak
  * @details [long description]
  * 
- * @param resource The surf workstation
+ * @param host The surf workstation
  * @return The power peak
  */
 XBT_PUBLIC(double) surf_workstation_get_current_power_peak(surf_resource_t host);
@@ -607,7 +607,7 @@ XBT_PUBLIC(double) surf_workstation_get_current_power_peak(surf_resource_t host)
  * @brief [brief description]
  * @details [long description]
  * 
- * @param resource [description]
+ * @param host [description]
  * @param pstate_index [description]
  * 
  * @return [description]
@@ -618,7 +618,7 @@ XBT_PUBLIC(double) surf_workstation_get_power_peak_at(surf_resource_t host, int
  * @brief [brief description]
  * @details [long description]
  * 
- * @param resource [description]
+ * @param host [description]
  * @return [description]
  */
 XBT_PUBLIC(int) surf_workstation_get_nb_pstates(surf_resource_t host);
@@ -627,7 +627,7 @@ XBT_PUBLIC(int) surf_workstation_get_nb_pstates(surf_resource_t host);
  * @brief [brief description]
  * @details [long description]
  * 
- * @param resource [description]
+ * @param host [description]
  * @param pstate_index [description]
  */
 XBT_PUBLIC(void) surf_workstation_set_power_peak_at(surf_resource_t host, int pstate_index);
@@ -635,7 +635,7 @@ XBT_PUBLIC(void) surf_workstation_set_power_peak_at(surf_resource_t host, int ps
 /**
  * @brief Get the consumed energy (in joules) of a workstation
  * 
- * @param resource The surf workstation
+ * @param host The surf workstation
  * @return The consumed energy
  */
 XBT_PUBLIC(double) surf_workstation_get_consumed_energy(surf_resource_t host);
@@ -862,7 +862,7 @@ XBT_PUBLIC(int) surf_action_get_cost(surf_action_t action);
  * 
  * @param action The surf cpu action
  * @param cpu [description]
- * @param long [description]
+ * @param mask [description]
  */
 XBT_PUBLIC(void) surf_cpu_action_set_affinity(surf_action_t action, surf_resource_t cpu, unsigned long mask);
 
index 3638f9d..a6d4253 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2004-2013. The SimGrid Team.
+/* Copyright (c) 2004-2014. The SimGrid Team.
  * All rights reserved.                                                       */
 
 /* This program is free software; you can redistribute it and/or modify it
@@ -264,7 +264,7 @@ const char *MSG_storage_get_name(msg_storage_t storage) {
 /** \ingroup msg_storage_management
  * \brief Returns the free space size of a storage element
  * \param name the name of a storage
- * \return the free space size of the storage element (as a sg_size_t)
+ * \return the free space size of the storage element (as a #sg_size_t)
  */
 sg_size_t MSG_storage_get_free_size(const char* name){
   return simcall_storage_get_free_size(name);
@@ -273,7 +273,7 @@ sg_size_t MSG_storage_get_free_size(const char* name){
 /** \ingroup msg_storage_management
  * \brief Returns the used space size of a storage element
  * \param name the name of a storage
- * \return the used space size of the storage element (as a sg_size_t)
+ * \return the used space size of the storage element (as a #sg_size_t)
  */
 sg_size_t MSG_storage_get_used_size(const char* name){
   return simcall_storage_get_used_size(name);
index 1178388..4877bde 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2004-2013. The SimGrid Team.
+/* Copyright (c) 2004-2014. The SimGrid Team.
  * All rights reserved.                                                     */
 
 /* This program is free software; you can redistribute it and/or modify it
@@ -32,25 +32,25 @@ CpuPtr getActionCpu(CpuActionPtr action);
 
 /** @ingroup SURF_callbacks
  * @brief Callbacks handler which emit the callbacks after Cpu creation * 
- * @detail Callback functions have the following signature: `void(CpuPtr)`
+ * @details Callback functions have the following signature: `void(CpuPtr)`
  */
 extern surf_callback(void, CpuPtr) cpuCreatedCallbacks;
 
 /** @ingroup SURF_callbacks
  * @brief Callbacks handler which emit the callbacks after Cpu destruction * 
- * @detail Callback functions have the following signature: `void(CpuPtr)`
+ * @details Callback functions have the following signature: `void(CpuPtr)`
  */
 extern surf_callback(void, CpuPtr) cpuDestructedCallbacks;
 
 /** @ingroup SURF_callbacks
  * @brief Callbacks handler which emit the callbacks after Cpu State changed * 
- * @detail Callback functions have the following signature: `void(CpuActionPtr)`
+ * @details Callback functions have the following signature: `void(CpuActionPtr)`
  */
 extern surf_callback(void, CpuPtr) cpuStateChangedCallbacks;
 
 /** @ingroup SURF_callbacks
  * @brief Callbacks handler which emit the callbacks after CpuAction State changed * 
- * @detail Callback functions have the following signature: `void(CpuActionPtr)`
+ * @details Callback functions have the following signature: `void(CpuActionPtr)`
  */
 extern surf_callback(void, CpuActionPtr) cpuActionStateChangedCallbacks;
 
@@ -244,7 +244,7 @@ public:
    * @details [TODO]
    * 
    * @param cpu [TODO]
-   * @param long [TODO]
+   * @param mask [TODO]
    */
   virtual void setAffinity(CpuPtr cpu, unsigned long mask);
 
index 9a68045..b184770 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2004-2013. The SimGrid Team.
+/* Copyright (c) 2004-2014. The SimGrid Team.
  * All rights reserved.                                                     */
 
 /* This program is free software; you can redistribute it and/or modify it
@@ -28,25 +28,25 @@ typedef NetworkAction *NetworkActionPtr;
 
 /** @ingroup SURF_callbacks
  * @brief Callbacks handler which emit the callbacks after NetworkLink creation *
- * @detail Callback functions have the following signature: `void(NetworkLinkPtr)`
+ * @details Callback functions have the following signature: `void(NetworkLinkPtr)`
  */
 extern surf_callback(void, NetworkLinkPtr) networkLinkCreatedCallbacks;
 
 /** @ingroup SURF_callbacks
  * @brief Callbacks handler which emit the callbacks after NetworkLink destruction *
- * @detail Callback functions have the following signature: `void(NetworkLinkPtr)`
+ * @details Callback functions have the following signature: `void(NetworkLinkPtr)`
  */
 extern surf_callback(void, NetworkLinkPtr) networkLinkDestructedCallbacks;
 
 /** @ingroup SURF_callbacks
  * @brief Callbacks handler which emit the callbacks after NetworkLink State changed *
- * @detail Callback functions have the following signature: `void(NetworkLinkActionPtr)`
+ * @details Callback functions have the following signature: `void(NetworkLinkActionPtr)`
  */
 extern surf_callback(void, NetworkLinkPtr) networkLinkStateChangedCallbacks;
 
 /** @ingroup SURF_callbacks
  * @brief Callbacks handler which emit the callbacks after NetworkAction State changed *
- * @detail Callback functions have the following signature: `void(NetworkActionPtr)`
+ * @details Callback functions have the following signature: `void(NetworkActionPtr)`
  */
 extern surf_callback(void, NetworkActionPtr) networkActionStateChangedCallbacks;
 
index d8d4e18..b014d25 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2004-2013. The SimGrid Team.
+/* Copyright (c) 2004-2014. The SimGrid Team.
  * All rights reserved.                                                     */
 
 /* This program is free software; you can redistribute it and/or modify it
@@ -36,25 +36,25 @@ typedef StorageAction *StorageActionPtr;
 
 /** @ingroup SURF_callbacks
  * @brief Callbacks handler which emit the callbacks after Storage creation *
- * @detail Callback functions have the following signature: `void(StoragePtr)`
+ * @details Callback functions have the following signature: `void(StoragePtr)`
  */
 extern surf_callback(void, StoragePtr) storageCreatedCallbacks;
 
 /** @ingroup SURF_callbacks
  * @brief Callbacks handler which emit the callbacks after Storage destruction *
- * @detail Callback functions have the following signature: `void(StoragePtr)`
+ * @details Callback functions have the following signature: `void(StoragePtr)`
  */
 extern surf_callback(void, StoragePtr) storageDestructedCallbacks;
 
 /** @ingroup SURF_callbacks
  * @brief Callbacks handler which emit the callbacks after Storage State changed *
- * @detail Callback functions have the following signature: `void(StorageActionPtr)`
+ * @details Callback functions have the following signature: `void(StorageActionPtr)`
  */
 extern surf_callback(void, StoragePtr) storageStateChangedCallbacks;
 
 /** @ingroup SURF_callbacks
  * @brief Callbacks handler which emit the callbacks after StorageAction State changed *
- * @detail Callback functions have the following signature: `void(StorageActionPtr)`
+ * @details Callback functions have the following signature: `void(StorageActionPtr)`
  */
 extern surf_callback(void, StorageActionPtr) storageActionStateChangedCallbacks;
 
@@ -108,17 +108,14 @@ public:
    * @param model StorageModel associated to this Storage
    * @param name The name of the Storage
    * @param props Dictionary of properties associated to this Storage
-   * @param constraint The lmm constraint associated to this Storage if it is part of a LMM component
-   * @param model [description]
-   * @param name [description]
-   * @param props [description]
    * @param type_id [description]
    * @param content_name [description]
    * @param content_type [description]
    * @param size [description]
    */
   Storage(ModelPtr model, const char *name, xbt_dict_t props,
-                 const char* type_id, char *content_name, char *content_type, sg_size_t size);
+          const char* type_id, char *content_name, char *content_type,
+          sg_size_t size);
 
   /**
    * @brief Storage constructor
@@ -126,7 +123,6 @@ public:
    * @param model StorageModel associated to this Storage
    * @param name The name of the Storage
    * @param props Dictionary of properties associated to this Storage
-   * @param constraint The lmm constraint associated to this Storage if it is part of a LMM component
    * @param maxminSystem [description]
    * @param bread [description]
    * @param bwrite [description]
@@ -137,8 +133,10 @@ public:
    * @param size [description]
    */
   Storage(ModelPtr model, const char *name, xbt_dict_t props,
-                 lmm_system_t maxminSystem, double bread, double bwrite, double bconnection,
-                 const char* type_id, char *content_name, char *content_type, sg_size_t size);
+          lmm_system_t maxminSystem, double bread, double bwrite,
+          double bconnection,
+          const char* type_id, char *content_name, char *content_type,
+          sg_size_t size);
 
   /**
    * @brief Storage destructor
index ffceddc..84593b5 100644 (file)
@@ -197,7 +197,7 @@ public:
    * @brief share the resources
    * @details Share the resources between the actions 
    * 
-   * @param 
+   * @param now [TODO]
    * @return the date of the next action will finish
    */
   virtual double shareResources(double now);
index 20b1700..262b288 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2004-2013. The SimGrid Team.
+/* Copyright (c) 2004-2014. The SimGrid Team.
  * All rights reserved.                                                     */
 
 /* This program is free software; you can redistribute it and/or modify it
@@ -33,19 +33,19 @@ typedef WorkstationVMLmm *WorkstationVMLmmPtr;
 
 /** @ingroup SURF_callbacks
  * @brief Callbacks handler which emit the callbacks after WorkstationVM creation *
- * @detail Callback functions have the following signature: `void(WorkstationVMPtr)`
+ * @details Callback functions have the following signature: `void(WorkstationVMPtr)`
  */
 extern surf_callback(void, WorkstationVMPtr) workstationVMCreatedCallbacks;
 
 /** @ingroup SURF_callbacks
  * @brief Callbacks handler which emit the callbacks after WorkstationVM destruction *
- * @detail Callback functions have the following signature: `void(WorkstationVMPtr)`
+ * @details Callback functions have the following signature: `void(WorkstationVMPtr)`
  */
 extern surf_callback(void, WorkstationVMPtr) workstationVMDestructedCallbacks;
 
 /** @ingroup SURF_callbacks
  * @brief Callbacks handler which emit the callbacks after WorkstationVM State changed *
- * @detail Callback functions have the following signature: `void(WorkstationVMActionPtr)`
+ * @details Callback functions have the following signature: `void(WorkstationVMActionPtr)`
  */
 extern surf_callback(void, WorkstationVMPtr) workstationVMStateChangedCallbacks;
 
index 297cf8f..d0546b5 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2004-2013. The SimGrid Team.
+/* Copyright (c) 2004-2014. The SimGrid Team.
  * All rights reserved.                                                     */
 
 /* This program is free software; you can redistribute it and/or modify it
@@ -31,25 +31,25 @@ typedef WorkstationAction *WorkstationActionPtr;
 
 /** @ingroup SURF_callbacks
  * @brief Callbacks handler which emit the callbacks after Workstation creation *
- * @detail Callback functions have the following signature: `void(WorkstationPtr)`
+ * @details Callback functions have the following signature: `void(WorkstationPtr)`
  */
 extern surf_callback(void, WorkstationPtr) workstationCreatedCallbacks;
 
 /** @ingroup SURF_callbacks
  * @brief Callbacks handler which emit the callbacks after Workstation destruction *
- * @detail Callback functions have the following signature: `void(WorkstationPtr)`
+ * @details Callback functions have the following signature: `void(WorkstationPtr)`
  */
 extern surf_callback(void, WorkstationPtr) workstationDestructedCallbacks;
 
 /** @ingroup SURF_callbacks
  * @brief Callbacks handler which emit the callbacks after Workstation State changed *
- * @detail Callback functions have the following signature: `void(WorkstationActionPtr)`
+ * @details Callback functions have the following signature: `void(WorkstationActionPtr)`
  */
 extern surf_callback(void, WorkstationPtr) workstationStateChangedCallbacks;
 
 /** @ingroup SURF_callbacks
  * @brief Callbacks handler which emit the callbacks after WorkstationAction State changed *
- * @detail Callback functions have the following signature: `void(WorkstationActionPtr)`
+ * @details Callback functions have the following signature: `void(WorkstationActionPtr)`
  */
 extern surf_callback(void, WorkstationActionPtr) workstationActionStateChangedCallbacks;
 
@@ -290,6 +290,7 @@ public:
    * @brief List directory contents of a path
    * @details [long description]
    * 
+   * @param mount [description]
    * @param path The path to the directory
    * @return The StorageAction corresponding to the ls action
    */