Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
laurent's eclipse was a bit too greedy
[simgrid.git] / org / simgrid / msg / Msg.java
index da8f553..64c0713 100644 (file)
@@ -1,7 +1,7 @@
 /*
  * JNI interface to C code for MSG.
  * 
- * Copyright 2006,2007,2010 The SimGrid Team.           
+ * Copyright 2006,2007,2010,2011 The SimGrid Team.           
  * All right reserved. 
  *
  * This program is free software; you can redistribute 
@@ -26,7 +26,9 @@ public final class Msg {
        }
 
        /* FIXME: kill these C crufts */
-       /** Returns the last error code of the simulation */
+    /** Returns the last error code of the simulation
+     * @return
+     */
        public final static native int getErrCode();
 
        /** Everything is right. Keep on going the way ! */
@@ -50,10 +52,14 @@ public final class Msg {
        /** You've done something wrong. You'd better look at it... */
        public static final int FATAL_ERROR = 5;
 
-       /** Retrieve the simulation time */
+    /** Retrieve the simulation time
+     * @return
+     */
        public final static native double getClock();
 
-       /** Issue an information logging message */
+    /** Issue an information logging message
+     * @param s
+     */
        public final static native void info(String s);
 
        /*********************************************************************************
@@ -90,11 +96,15 @@ public final class Msg {
        /**
         * The method to deploy the simulation.
         *
-        * @param platformFile    The XML file which contains the description of the application to deploy.
-        */
+     *
+     * @param deploymentFile
+     */
        public final static native void deployApplication(String deploymentFile);
 
-       /** Example launcher. You can use it or provide your own launcher, as you wish */
+    /** Example launcher. You can use it or provide your own launcher, as you wish
+     * @param args
+     * @throws MsgException
+     */
        static public void main(String[]args) throws MsgException {
                /* initialize the MSG simulation. Must be done before anything else (even logging). */
                Msg.init(args);