Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Fix doxygen warnings.
authorArnaud Giersch <arnaud.giersch@iut-bm.univ-fcomte.fr>
Sat, 8 Mar 2014 17:41:06 +0000 (18:41 +0100)
committerArnaud Giersch <arnaud.giersch@iut-bm.univ-fcomte.fr>
Sat, 8 Mar 2014 22:10:17 +0000 (23:10 +0100)
doc/doxygen/module-surf.doc
include/msg/datatypes.h
src/msg/msg_io.c
src/surf/storage_interface.hpp

index 7e3733f..e4aed28 100644 (file)
@@ -3,9 +3,8 @@
   \section SURF_doc Surf documentation
    Surf is composed several components:
    - \ref SURF_simulation
   \section SURF_doc Surf documentation
    Surf is composed several components:
    - \ref SURF_simulation
-   - \ref SURF_actions
-   - \ref SURF_resources
    - \ref SURF_build_api
    - \ref SURF_build_api
+   - \ref SURF_c_bindings
    - \ref SURF_interface
    - \ref SURF_routing_interface
    - \ref SURF_cpu_interface
    - \ref SURF_interface
    - \ref SURF_routing_interface
    - \ref SURF_cpu_interface
@@ -13,6 +12,7 @@
    - \ref SURF_storage_interface
    - \ref SURF_workstation_interface
    - \ref SURF_vm_workstation_interface
    - \ref SURF_storage_interface
    - \ref SURF_workstation_interface
    - \ref SURF_vm_workstation_interface
+   - \ref SURF_lmm
    - \ref SURF_callbacks
    - \ref SURF_plugin_energy
    
    - \ref SURF_callbacks
    - \ref SURF_plugin_energy
    
 */
 
 /**
 */
 
 /**
-@defgroup SURF_routing_interface   SURF Routing Interface
+@defgroup SURF_interface   SURF Interface
 @ingroup SURF_API
 @ingroup SURF_API
-@brief Describes the routing interface
+@brief Describes the general interface for all components (Cpu, Network, Storage, Workstation, WorkstationVM)
 
 
-@htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Surf Routing" --> @endhtmlonly
+@htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Surf Interface" --> @endhtmlonly
 */
 
 /**
 */
 
 /**
-@defgroup SURF_interface   SURF Interface
+@defgroup SURF_routing_interface   SURF Routing Interface
 @ingroup SURF_API
 @ingroup SURF_API
-@brief Describes the general interface for all components (Cpu, Network, Storage, Workstation, WorkstationVM)
+@brief Describes the routing interface
 
 
-@htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Surf Interface" --> @endhtmlonly
+@htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Surf Routing" --> @endhtmlonly
 */
 
 /**
 */
 
 /**
 @brief Describes how to use the energy plugin.
 
 @htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Energy plugin" --> @endhtmlonly
 @brief Describes how to use the energy plugin.
 
 @htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Energy plugin" --> @endhtmlonly
-*/
\ No newline at end of file
+*/
index d4e254b..d898c4d 100644 (file)
@@ -99,18 +99,16 @@ static inline msg_vm_priv_t MSG_vm_priv(msg_vm_t vm){
 /** ******************************** File ************************************ */
 
 /** @brief File datatype.
 /** ******************************** File ************************************ */
 
 /** @brief File datatype.
-// *  @ingroup msg_file_management
-// *
-// *  You should consider this as an opaque object.
-// */
-//
-//typedef struct msg_file *msg_file_t;
-extern int MSG_FILE_LEVEL;
-typedef struct simdata_file *simdata_file_t;
-
+*  @ingroup msg_file_management
+*
+*  You should consider this as an opaque object.
+*/
 typedef xbt_dictelm_t msg_file_t;
 typedef s_xbt_dictelm_t s_msg_file_t;
 
 typedef xbt_dictelm_t msg_file_t;
 typedef s_xbt_dictelm_t s_msg_file_t;
 
+extern int MSG_FILE_LEVEL;
+typedef struct simdata_file *simdata_file_t;
+
 typedef struct msg_file_priv  {
   const char *fullname;
   sg_size_t size;
 typedef struct msg_file_priv  {
   const char *fullname;
   sg_size_t size;
index 36361fc..d0b77c5 100644 (file)
@@ -209,7 +209,7 @@ xbt_dict_t MSG_file_ls(const char *mount, const char *path)
  * \param fd : file object that identifies the stream
  * \param offset : number of bytes to offset from origin
  * \param origin : Position used as reference for the offset. It is specified by
  * \param fd : file object that identifies the stream
  * \param offset : number of bytes to offset from origin
  * \param origin : Position used as reference for the offset. It is specified by
- * one of the following constants defined in <cstdio> exclusively to be used as
+ * one of the following constants defined in \<stdio.h\> exclusively to be used as
  * arguments for this function (SEEK_SET = beginning of file, SEEK_CUR = current
  * position of the file pointer, SEEK_END = end of file)
  *
  * arguments for this function (SEEK_SET = beginning of file, SEEK_CUR = current
  * position of the file pointer, SEEK_END = end of file)
  *
index ca24eb7..d70771c 100644 (file)
@@ -85,10 +85,15 @@ public:
    * @param content_name [description]
    * @param content_type [description]
    * @param properties [description]
    * @param content_name [description]
    * @param content_type [description]
    * @param properties [description]
+   * @param attach [description]
    * @return The created Storage
    */
    * @return The created Storage
    */
-  virtual StoragePtr createResource(const char* id, const char* type_id,
-                  const char* content_name, const char* content_type, xbt_dict_t properties,const char *attach)=0;
+  virtual StoragePtr createResource(const char* id,
+                                    const char* type_id,
+                                    const char* content_name,
+                                    const char* content_type,
+                                    xbt_dict_t properties,
+                                    const char *attach) = 0;
 
   xbt_dynar_t p_storageList;
 };
 
   xbt_dynar_t p_storageList;
 };
@@ -131,6 +136,7 @@ public:
    * @param content_name [description]
    * @param content_type [description]
    * @param size [description]
    * @param content_name [description]
    * @param content_type [description]
    * @param size [description]
+   * @param attach [description]
    */
   Storage(ModelPtr model, const char *name, xbt_dict_t props,
           lmm_system_t maxminSystem, double bread, double bwrite,
    */
   Storage(ModelPtr model, const char *name, xbt_dict_t props,
           lmm_system_t maxminSystem, double bread, double bwrite,