From: Arnaud Giersch <arnaud.giersch@iut-bm.univ-fcomte.fr>
Date: Thu, 19 Sep 2013 12:52:44 +0000 (+0200)
Subject: Fix doxygen comments.
X-Git-Tag: v3_9_90~104^2~26
X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/7d25326366e9764913af94b28b4d343ddf4c239d

Fix doxygen comments.

* declare msg_storage_t
* add missing names for the parameters
* fix spurious "@htmlonly" appearing in the generated doc
* plus a typo (Altough -> Although)
---

diff --git a/include/msg/datatypes.h b/include/msg/datatypes.h
index 8ecd1ca099..53905bf28d 100644
--- a/include/msg/datatypes.h
+++ b/include/msg/datatypes.h
@@ -117,9 +117,9 @@ typedef struct msg_file {
 } s_msg_file_t;
 
 /** @brief File datatype.
-    @ingroup msg_file_management 
- 
-    You should consider this as an opaque object.
+ *  @ingroup msg_file_management
+ *
+ *  You should consider this as an opaque object.
  */
 
 typedef struct msg_file *msg_file_t;
@@ -129,6 +129,11 @@ typedef struct msg_file *msg_file_t;
 
 extern int MSG_STORAGE_LEVEL;
 
+/** @brief Storage datatype.
+ *  @ingroup msg_storage_management
+ *
+ *  You should consider this as an opaque object.
+ */
 typedef xbt_dictelm_t msg_storage_t;
 typedef s_xbt_dictelm_t s_msg_storage_t;
 
diff --git a/src/bindings/java/org/simgrid/msg/MsgException.java b/src/bindings/java/org/simgrid/msg/MsgException.java
index b41bd30e3d..d56b7ea33f 100644
--- a/src/bindings/java/org/simgrid/msg/MsgException.java
+++ b/src/bindings/java/org/simgrid/msg/MsgException.java
@@ -12,14 +12,13 @@ package org.simgrid.msg;
 
 /**
  * This exception is an abstract class grouping all MSG-related exceptions
-  
-    \htmlonly <!-- 
-      DOXYGEN_NAVBAR_CHILD "HostNotFoundException"=classsimgrid_1_1msg_1_1HostNotFoundException.html
-      DOXYGEN_NAVBAR_CHILD "JniException"=classsimgrid_1_1msg_1_1JniException.html
-      DOXYGEN_NAVBAR_CHILD "NativeException"=classsimgrid_1_1msg_1_1NativeException.html
-      DOXYGEN_NAVBAR_CHILD "ProcessNotFoundException"=classsimgrid_1_1msg_1_1ProcessNotFoundException.html
-    --> \endhtmlonly 
-  
+ *
+ *  <!--
+ *    DOXYGEN_NAVBAR_CHILD "HostNotFoundException"=classsimgrid_1_1msg_1_1HostNotFoundException.html
+ *    DOXYGEN_NAVBAR_CHILD "JniException"=classsimgrid_1_1msg_1_1JniException.html
+ *    DOXYGEN_NAVBAR_CHILD "NativeException"=classsimgrid_1_1msg_1_1NativeException.html
+ *    DOXYGEN_NAVBAR_CHILD "ProcessNotFoundException"=classsimgrid_1_1msg_1_1ProcessNotFoundException.html
+ *  -->
  */
 public abstract class MsgException extends Exception {
   private static final long serialVersionUID = 1L;
diff --git a/src/msg/msg_host.c b/src/msg/msg_host.c
index f6ee22bc5d..7b49fe7727 100644
--- a/src/msg/msg_host.c
+++ b/src/msg/msg_host.c
@@ -13,7 +13,7 @@
 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(msg);
 
 /** @addtogroup m_host_management
- *     \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Hosts" --> \endhtmlonly
+ * \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Hosts" --> \endhtmlonly
  * (#msg_host_t) and the functions for managing it.
  *  
  *  A <em>location</em> (or <em>host</em>) is any possible place where
diff --git a/src/msg/msg_io.c b/src/msg/msg_io.c
index d69d7628c5..8d9fa637fe 100644
--- a/src/msg/msg_io.c
+++ b/src/msg/msg_io.c
@@ -11,7 +11,7 @@ XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_io, msg,
                                 "Logging specific to MSG (io)");
 
 /** @addtogroup msg_file_management
- *     \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Files" --> \endhtmlonly
+ * \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Files" --> \endhtmlonly
  * (#msg_file_t) and the functions for managing it.
  *
  *  \see #msg_file_t
@@ -181,7 +181,7 @@ xbt_dict_t MSG_file_ls(const char *mount, const char *path)
 /********************************* Storage **************************************/
 
 /** @addtogroup msg_storage_management
- *     \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Storages" --> \endhtmlonly
+ * \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Storages" --> \endhtmlonly
  * (#msg_storage_t) and the functions for managing it.
  *
  */
@@ -215,7 +215,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 the storage name (#char*)
+ * \param name the name of a storage
  * \return the free space size of the storage element (as a size_t)
  */
 size_t MSG_storage_get_free_size(const char* name){
@@ -224,7 +224,7 @@ 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 the storage name (#char*)
+ * \param name the name of a storage
  * \return the used space size of the storage element (as a size_t)
  */
 size_t MSG_storage_get_used_size(const char* name){
@@ -244,7 +244,7 @@ xbt_dict_t MSG_storage_get_properties(msg_storage_t storage)
 
 /** \ingroup msg_storage_management
  * \brief Finds a msg_storage_t using its name.
- * \param name the name of a storage.
+ * \param name the name of a storage
  * \return the corresponding storage
  */
 msg_storage_t MSG_storage_get_by_name(const char *name)
diff --git a/src/msg/msg_process.c b/src/msg/msg_process.c
index be51825563..449c5aef44 100644
--- a/src/msg/msg_process.c
+++ b/src/msg/msg_process.c
@@ -12,7 +12,7 @@ XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_process, msg,
                                 "Logging specific to MSG (process)");
 
 /** @addtogroup m_process_management
- *    \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Processes" --> \endhtmlonly
+ * \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Processes" --> \endhtmlonly
  *
  *  We need to simulate many independent scheduling decisions, so
  *  the concept of <em>process</em> is at the heart of the
diff --git a/tools/doxygen/index_create.pl b/tools/doxygen/index_create.pl
index e7522ccceb..858e611eee 100755
--- a/tools/doxygen/index_create.pl
+++ b/tools/doxygen/index_create.pl
@@ -40,13 +40,13 @@ print OUTPUT <<EOF;
 This file was generated by tools/doxygen/index_create.pl. DO NOT EDIT.
 
 /** \\defgroup API_index Full Index
-  * \\brief The alphabetical list of all functions, macros and types 
-  *  defined by SimGrid
-  *
-  * List of all functions, variables, defines, enums, and typedefs with
-  * links to the files they belong to. 
-  *
-  * \\htmlonly Altough completely useless, the complete list of structures defined can be found <a href="annotated.html">here</a> \\endhtmlonly
+ * \\brief The alphabetical list of all functions, macros and types
+ *  defined by SimGrid
+ *
+ * List of all functions, variables, defines, enums, and typedefs with
+ * links to the files they belong to.
+ *
+ * \\htmlonly Although completely useless, the complete list of structures defined can be found <a href="annotated.html">here</a> \\endhtmlonly
 
 
 EOF