Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge pull request #2 from mquinson/master
[simgrid.git] / src / bindings / java / jmsg_host.h
index 5a342f2..327940c 100644 (file)
@@ -17,14 +17,14 @@ SG_BEGIN_DECL()
 /**
  * This function returns a new java host instance.
  *
- * @param env                  The environment of the current thread
+ * @param env      The environment of the current thread
  *
- * @return                             A new java host object.
+ * @return        A new java host object.
  *
- * @exception                  If the class Host is not found the function throws 
- *                                             the ClassNotFoundException. If the constructor of 
- *                                             this class is not found the function throws the exception 
- *                                             NotSuchMethodException.
+ * @exception      If the class Host is not found the function throws 
+ *            the ClassNotFoundException. If the constructor of 
+ *            this class is not found the function throws the exception 
+ *            NotSuchMethodException.
  */
 jobject jhost_new_instance(JNIEnv * env);
 
@@ -32,58 +32,58 @@ jobject jhost_new_instance(JNIEnv * env);
  * This function returns a global reference to the  java host instance 
  * specified by the parameter jhost.
  *
- * @param jhost                        The original java host instance.
- * @param env                  The environment of the current thread
+ * @param jhost      The original java host instance.
+ * @param env      The environment of the current thread
  *
- * @return                             The global reference to the original java host 
- *                                             instance.
+ * @return        The global reference to the original java host 
+ *            instance.
  */
 jobject jhost_ref(JNIEnv * env, jobject jhost);
 /**
  * This function delete a global reference to a java host instance.
  *
- * @param                              The global refernce to delete.
- * @param env                  The environment of the current thread
+ * @param        The global refernce to delete.
+ * @param env      The environment of the current thread
  */
 void jhost_unref(JNIEnv * env, jobject jhost);
 
 /**
  * This function associated a native host to a java host instance.
  *
- * @param jhost                        The java host instance.
- * @param host                 The native host to bind.
- * @param env                  The environment of the current thread
+ * @param jhost      The java host instance.
+ * @param host      The native host to bind.
+ * @param env      The environment of the current thread
  *
- * @exception                  If the class Host is not found the function throws 
- *                                             the ClassNotFoundException. If the field bind of 
- *                                             this class is not found the function throws the exception 
- *                                             NotSuchFieldException.  
+ * @exception      If the class Host is not found the function throws 
+ *            the ClassNotFoundException. If the field bind of 
+ *            this class is not found the function throws the exception 
+ *            NotSuchFieldException.  
  */
 void jhost_bind(jobject jhost, msg_host_t host, JNIEnv * env);
 
 /**
  * This function returns a native host from a java host instance.
  *
- * @param jhost                        The java host object from which get the native host.
- * @param env                  The environment of the current thread
+ * @param jhost      The java host object from which get the native host.
+ * @param env      The environment of the current thread
  *
- * @return                             The function returns the native host associated to the
- *                                             java host object.
+ * @return        The function returns the native host associated to the
+ *            java host object.
  *
- * @exception                  If the class Host is not found the function throws 
- *                                             the ClassNotFoundException. If the field bind of 
- *                                             this class is not found the function throws the exception 
- *                                             NotSuchFieldException.  
+ * @exception      If the class Host is not found the function throws 
+ *            the ClassNotFoundException. If the field bind of 
+ *            this class is not found the function throws the exception 
+ *            NotSuchFieldException.  
  */
 msg_host_t jhost_get_native(JNIEnv * env, jobject jhost);
 
 /**
  * This function returns the name of a MSG host.
  *
- * @param jhost                        A java host object.
- * @param env                  The environment of the current thread
+ * @param jhost      A java host object.
+ * @param env      The environment of the current thread
  *
- * @return                             The name of the host.
+ * @return        The name of the host.
  */
 const char *jhost_get_name(jobject jhost, JNIEnv * env);
 
@@ -91,25 +91,25 @@ const char *jhost_get_name(jobject jhost, JNIEnv * env);
  * This function tests if a java host instance is valid.
  * A java host object is valid if it is bind to a native host.
  *
- * @param jhost                        The host to test the validity.
- * @param env                  The environment of the current thread
+ * @param jhost      The host to test the validity.
+ * @param env      The environment of the current thread
  *
- * @return                             If the java host is valid the function returns true.
- *                                             Otherwise the function returns false.
+ * @return        If the java host is valid the function returns true.
+ *            Otherwise the function returns false.
  */
 jboolean jhost_is_valid(jobject jhost, JNIEnv * env);
 /*
- * Class               org_simgrid_msg_Host
- * Method              nativeInit
- * Signature   ();
+ * Class    org_simgrid_msg_Host
+ * Method    nativeInit
+ * Signature  ();
  */
 JNIEXPORT void JNICALL
 Java_org_simgrid_msg_Host_nativeInit(JNIEnv *env, jclass cls);
 
 /*
- * Class               org_simgrid_msg_Host
- * Method              getByName
- * Signature   (Ljava/lang/String;)Lsimgrid/msg/Host;
+ * Class    org_simgrid_msg_Host
+ * Method    getByName
+ * Signature  (Ljava/lang/String;)Lsimgrid/msg/Host;
  */
 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Host_getByName
     (JNIEnv *, jclass, jstring);
@@ -117,8 +117,8 @@ JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Host_getByName
 /**
  * This function start the host if it is off
  *
- * @param jhost                        The host to test the validity.
- * @param env                  The environment of the current thread
+ * @param jhost      The host to test the validity.
+ * @param env      The environment of the current thread
  *
  */
 JNIEXPORT void JNICALL Java_org_simgrid_msg_Host_on(JNIEnv *env, jobject jhost);
@@ -126,38 +126,38 @@ JNIEXPORT void JNICALL Java_org_simgrid_msg_Host_on(JNIEnv *env, jobject jhost);
 /**
  * This function stop the host if it is on
  *
- * @param jhost                        The host to test the validity.
- * @param env                  The environment of the current thread
+ * @param jhost      The host to test the validity.
+ * @param env      The environment of the current thread
  *
  */
 JNIEXPORT void JNICALL Java_org_simgrid_msg_Host_off(JNIEnv *env, jobject jhost);
 
 /*
- * Class               org_simgrid_msg_Host
- * Method              currentHost
- * Signature   ()Lsimgrid/msg/Host;
+ * Class    org_simgrid_msg_Host
+ * Method    currentHost
+ * Signature  ()Lsimgrid/msg/Host;
  */
 JNIEXPORT jobject JNICALL Java_org_simgrid_msg_Host_currentHost
     (JNIEnv *, jclass);
 /*
- * Class               org_simgrid_msg_Host
- * Method              getCount
- * Signature   ()I
+ * Class    org_simgrid_msg_Host
+ * Method    getCount
+ * Signature  ()I
  */
 JNIEXPORT jint JNICALL Java_org_simgrid_msg_Host_getCount
     (JNIEnv *, jclass);
 
 /*
- * Class               org_simgrid_msg_Host
- * Method              getSpeed
- * Signature   ()D
+ * Class    org_simgrid_msg_Host
+ * Method    getSpeed
+ * Signature  ()D
  */
 JNIEXPORT jdouble JNICALL Java_org_simgrid_msg_Host_getSpeed
     (JNIEnv *, jobject);
 /*
- * Class               org_simgrid_msg_Host
- * Method              getCoreNumber
- * Signature   ()D
+ * Class    org_simgrid_msg_Host
+ * Method    getCoreNumber
+ * Signature  ()D
  */
 JNIEXPORT jdouble JNICALL Java_org_simgrid_msg_Host_getCoreNumber
     (JNIEnv *, jobject);
@@ -176,30 +176,30 @@ Java_org_simgrid_msg_Host_getProperty(JNIEnv *env, jobject jhost, jobject jname)
 JNIEXPORT void JNICALL
 Java_org_simgrid_msg_Host_setProperty(JNIEnv *env, jobject jhost, jobject jname, jobject jvalue);
 /*
- * Class               org_simgrid_msg_Host
- * Method              isOn
- * Signature   ()Z
+ * Class    org_simgrid_msg_Host
+ * Method    isOn
+ * Signature  ()Z
  */
 JNIEXPORT jboolean JNICALL Java_org_simgrid_msg_Host_isOn
     (JNIEnv *, jobject);
 
 
 /*
- * Class               org_simgrid_msg_Host
- * Method              getMountedStorage
+ * Class    org_simgrid_msg_Host
+ * Method    getMountedStorage
  * Signature: ()[Lorg/simgrid/msg/Storage;
  */
 JNIEXPORT jobjectArray JNICALL Java_org_simgrid_msg_Host_getMountedStorage(JNIEnv * env, jobject jhost);
 
 /*
- * Class               org_simgrid_msg_Host
- * Method              getAttachedStorageList
+ * Class    org_simgrid_msg_Host
+ * Method    getAttachedStorageList
  */
 JNIEXPORT jobjectArray JNICALL Java_org_simgrid_msg_Host_getAttachedStorage(JNIEnv * env, jobject jhost);
 
 /*
- * Class               org_simgrid_msg_Host
- * Method              getStorageContent
+ * Class    org_simgrid_msg_Host
+ * Method    getStorageContent
  */
 JNIEXPORT jobjectArray JNICALL Java_org_simgrid_msg_Host_getStorageContent(JNIEnv * env, jobject jhost);