Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Fix another bunch of warnings in doc generation.
[simgrid.git] / src / bindings / java / org / simgrid / msg / Process.java
index cfbc5da..c198186 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2006-2019. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2006-2021. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
@@ -14,12 +14,12 @@ import java.util.Arrays;
  * declared in the deployment file (XML format).
  * To create your own process you must inherit your own process from this
  * class and override the method "main()". For example if you want to use
- * a process named Slave proceed as it :
+ * a process named Worker proceed as it :
  *
  * (1) import the class Process of the package simgrid.msg
  * import simgrid.msg.Process;
  *
- * public class Slave extends simgrid.msg.Process {
+ * public class Worker extends simgrid.msg.Process {
  *
  *  (2) Override the method function
  *
@@ -30,9 +30,9 @@ import java.util.Arrays;
  *  \endverbatim
  * }
  * The name of your process must be declared in the deployment file of your simulation.
- * For the example, for the previous process Slave this file must contains a line :
- * <process host="Maxims" function="Slave"/>, where Maxims is the host of the process
- * Slave. All the process of your simulation are automatically launched and managed by Msg.
+ * For the example, for the previous process Worker this file must contains a line :
+ * <process host="Maxims" function="Worker"/>, where Maxims is the host of the process
+ * Worker. All the process of your simulation are automatically launched and managed by Msg.
  * A process use tasks to simulate communications or computations with another process.
  * For more information see Task. For more information on host concept
  * see Host.
@@ -73,7 +73,7 @@ public abstract class Process implements Runnable {
         *
         *
         */
-       public Process(String hostname, String name) throws HostNotFoundException {
+       protected Process(String hostname, String name) throws HostNotFoundException {
                this(Host.getByName(hostname), name, null);
        }
        /**
@@ -87,7 +87,7 @@ public abstract class Process implements Runnable {
         * @exception                   HostNotFoundException  if no host with this name exists.
         *
         */
-       public Process(String hostname, String name, String[] args) throws HostNotFoundException {
+       protected Process(String hostname, String name, String[] args) throws HostNotFoundException {
                this(Host.getByName(hostname), name, args);
        }
        /**
@@ -98,7 +98,7 @@ public abstract class Process implements Runnable {
         * @param name                  The name of the process.
         *
         */
-       public Process(Host host, String name) {
+       protected Process(Host host, String name) {
                this(host, name, null);
        }
        /**
@@ -109,7 +109,7 @@ public abstract class Process implements Runnable {
         * @param name                  The name of the process.
         * @param argsParam             The arguments of main method of the process.
         */     
-       public Process(Host host, String name, String[]argsParam)
+       protected Process(Host host, String name, String[]argsParam)
        {
                if (host == null)
                        throw new IllegalArgumentException("Cannot create a process on the null host");
@@ -134,7 +134,7 @@ public abstract class Process implements Runnable {
         * @param killTime              Kill time of the process
         *
         */
-       public Process(Host host, String name, String[]args, double startTime, double killTime) {
+       protected Process(Host host, String name, String[]args, double startTime, double killTime) {
                this(host, name, args);
                this.startTime = startTime;
                this.killTime = killTime;
@@ -165,8 +165,8 @@ public abstract class Process implements Runnable {
        public native void resume();    
        /** Tests if a process is suspended.
         *
-        * @see #suspend()
-        * @see #resume()
+        * @see suspend()
+        * @see resume()
         */
        public native boolean isSuspended();