Stupid me. Arguments should be marked with @a in inline documentation, not @e

git-svn-id: svn+ssh://scm.gforge.inria.fr/svn/simgrid/simgrid/trunk@5353 48e7efb5-ca39-0410-a469-dd3cf9ba447f

diff --git a/src/java/simgrid/msg/Host.java b/src/java/simgrid/msg/Host.java
index d018dfa..101ef96 100644 (file)
--- a/src/java/simgrid/msg/Host.java
+++ b/src/java/simgrid/msg/Host.java
@@ -37,7 +37,7 @@ try {
        System.err.println(e.toString());
 }
 ...
- * \endverbatim
+\endverbatim
  *
  * @author  Abdelmalek Cherier
  * @author  Martin Quinson
@@ -184,7 +184,7 @@ try {
     NativeException {
     MsgNative.hostPut(this, channel, task, -1);
   } 
-   /** Send the given task to the given channel of the host (waiting at most \e timeout seconds) */ 
+   /** Send the given task to the given channel of the host (waiting at most \a timeout seconds) */ 
    
     public void put(int channel, Task task,
                     double timeout) throws JniException, NativeException {
@@ -192,7 +192,7 @@ try {
   } 
   
   
-   /** Send the given task to the given channel of the host (capping the emision rate to \e maxrate) */ 
+   /** Send the given task to the given channel of the host (capping the emision rate to \a maxrate) */ 
    
     public void putBounded(int channel, Task task,
                            double maxrate) throws JniException,
@@ -212,25 +212,25 @@ try {
        MsgNative.taskSend(alias, task, -1);
        }
        
-        /** Send the given task in the mailbox associated with the alias of the current host (waiting at most \e timeout seconds) */
+        /** Send the given task in the mailbox associated with the alias of the current host (waiting at most \a timeout seconds) */
        public void send(Task task, double timeout) throws JniException, NativeException {
        String alias = this.getName() + ":" + Process.currentProcess().msgName();
        MsgNative.taskSend(alias, task, timeout);
        }
        
-        /** Send the given task to mailbox associated with the specified alias (waiting at most \e timeout seconds) */
+        /** Send the given task to mailbox associated with the specified alias (waiting at most \a timeout seconds) */
     public void send(String alias, Task task, double timeout) throws JniException, NativeException {
        MsgNative.taskSend(alias, task, timeout);
        }
        
-        /** Send the given task to the mailbox associated with the default alias (capping the emision rate to \e maxrate) */ 
+        /** Send the given task to the mailbox associated with the default alias (capping the emision rate to \a maxrate) */ 
        public void sendBounded(Task task, double maxrate) throws JniException, NativeException {
        String alias = this.getName() + ":" + Process.currentProcess().msgName();
                        
        MsgNative.taskSendBounded(alias, task, maxrate);
        }  
        
-        /** Send the given task to the mailbox associated with the specified alias (capping the emision rate to \e maxrate) */
+        /** Send the given task to the mailbox associated with the specified alias (capping the emision rate to \a maxrate) */
        public void sendBounded(String alias, Task task, double maxrate) throws JniException, NativeException {
        MsgNative.taskSendBounded(alias, task, maxrate);
        } 

diff --git a/src/java/simgrid/msg/Task.java b/src/java/simgrid/msg/Task.java
index a84dd6f..b31b823 100644 (file)
--- a/src/java/simgrid/msg/Task.java
+++ b/src/java/simgrid/msg/Task.java
@@ -64,7 +64,7 @@ public class Task {
      *
      * @param name             The name of the parallel task.
      * @param hosts            The list of hosts implied by the parallel task.
-     * @param computeDurations The amount of operations to be performed by each host of \e hosts.
+     * @param computeDurations The amount of operations to be performed by each host of \a hosts.
      * @param messageSizes     A matrix describing the amount of data to exchange between hosts.
      * 
      * @exception              JniException if the binding mecanism fails.
@@ -150,7 +150,7 @@ public class Task {
     return MsgNative.taskGet(channel, -1.0, null);
   }
    /**
-    * Retrieves next task on given channel of local host (wait at most \e timeout seconds)
+    * Retrieves next task on given channel of local host (wait at most \a timeout seconds)
     *
     * @exception  JniException if the binding mecanism fails.
     * @exception  NativeException if the retrival fails.
@@ -170,7 +170,7 @@ public class Task {
     return MsgNative.taskGet(channel, -1, host);
   }
    /**
-    * Retrieves next task from given host on given channel of local host (wait at most \e timeout seconds)
+    * Retrieves next task from given host on given channel of local host (wait at most \a timeout seconds)
     *
     * @exception  JniException if the binding mecanism fails.
     * @exception  NativeException if the retrival fails.
@@ -188,7 +188,7 @@ public class Task {
     return MsgNative.taskProbe(channel);
   }
    /**
-    * Counts tasks waiting on the given \e channel of local host and sent by given \e host
+    * Counts tasks waiting on the given \a channel of local host and sent by given \a host
     *
     * @exception  JniException if the binding mecanism fails.
     */ public static int probe(int channel, Host host) throws JniException {
@@ -251,7 +251,7 @@ public class Task {
        } 
        
        /**
-    * Send the task on the mailbox identified by the default alias  (wait at most \e timeout seconds)
+    * Send the task on the mailbox identified by the default alias  (wait at most \a timeout seconds)
     *
     * @exception  JniException if the binding mecanism fails.
     * @exception  NativeException if the retrival fails.
@@ -262,7 +262,7 @@ public class Task {
        } 
        
        /**
-    * Send the task on the mailbox identified by the specified alias  (wait at most \e timeout seconds)
+    * Send the task on the mailbox identified by the specified alias  (wait at most \a timeout seconds)
     *
     * @exception  JniException if the binding mecanism fails.
     * @exception  NativeException if the retrival fails.
@@ -273,7 +273,7 @@ public class Task {
        
        
        /**
-    * Send the task on the mailbox identified by the default alias  (capping the emision rate to \e maxrate) 
+    * Send the task on the mailbox identified by the default alias  (capping the emision rate to \a maxrate) 
     *
     * @exception  JniException if the binding mecanism fails.
     * @exception  NativeException if the retrival fails.
@@ -284,7 +284,7 @@ public class Task {
        } 
        
        /**
-    * Send the task on the mailbox identified by the specified alias  (capping the emision rate to \e maxrate) 
+    * Send the task on the mailbox identified by the specified alias  (capping the emision rate to \a maxrate) 
     *
     * @exception  JniException if the binding mecanism fails.
     * @exception  NativeException if the retrival fails.
@@ -316,7 +316,7 @@ public class Task {
        }
        
        /**
-    * Retrieves next task on the mailbox identified by the specified alias (wait at most \e timeout seconds)
+    * Retrieves next task on the mailbox identified by the specified alias (wait at most \a timeout seconds)
     *
     * @exception  JniException if the binding mecanism fails.
     * @exception  NativeException if the retrival fails.
@@ -337,7 +337,7 @@ public class Task {
        }
        
        /**
-    * Retrieves next task sended by a given host on the mailbox identified by the specified alias (wait at most \e timeout seconds)
+    * Retrieves next task sended by a given host on the mailbox identified by the specified alias (wait at most \a timeout seconds)
     *
     * @exception  JniException if the binding mecanism fails.
     * @exception  NativeException if the retrival fails.
@@ -391,7 +391,7 @@ public class Task {
        }
        
    /**
-    * Counts the number of tasks waiting to be received on the \e mailbox identified by the specified alias and sended by the current host.
+    * Counts the number of tasks waiting to be received on the \a mailbox identified by the specified alias and sended by the current host.
     *
     * @exception  JniException if the binding mecanism fails.
     * @exception  NativeException if the retrival fails.
@@ -402,7 +402,7 @@ public class Task {
        }
        
    /**
-    * Counts the number of tasks waiting to be received on the \e mailbox identified by the specified alia and sended by the specified \e host.
+    * Counts the number of tasks waiting to be received on the \a mailbox identified by the specified alia and sended by the specified \a host.
     *
     * @exception  JniException if the binding mecanism fails.
     * @exception  NativeException if the retrival fails.