fix javadoc (#464)

src/main/java/neqsim/dataPresentation/JFreeChart/graph2b.java

@@ -276,7 +276,7 @@ private void jButton1ActionPerformed(java.awt.event.ActionEvent evt) {// GEN-FIR
     /**
      * Exit the Application
      * 
-     * @param evt
+     * @param evt The event to exit the form
      */
     private void exitForm(java.awt.event.WindowEvent evt) {// GEN-FIRST:event_exitForm
         this.removeAll();

src/main/java/neqsim/processSimulation/SimulationInterface.java

@@ -24,7 +24,7 @@ public interface SimulationInterface extends NamedInterface, Runnable {
    * In this method all thermodynamic and unit operations will be calculated in a steady state
    * calculation.
    *
-   * @return void
+   *
    */
   @Override
   public void run();
@@ -39,7 +39,7 @@ public interface SimulationInterface extends NamedInterface, Runnable {
    * 
    * @param dt is the delta time step (seconds)
    *
-   * @return void
+   *
    */
   public void runTransient(double dt);
 

src/main/java/neqsim/processSimulation/costEstimation/CostEstimateBaseClass.java

@@ -2,7 +2,6 @@
 
 import java.util.ArrayList;
 import java.util.Objects;
-
 import neqsim.processSimulation.processEquipment.ProcessEquipmentInterface;
 import neqsim.processSimulation.processSystem.ProcessSystem;
 
@@ -34,8 +33,8 @@ public CostEstimateBaseClass(ProcessSystem process) {
 
     /**
      * 
-     * @param process
-     * @param costFactor
+     * @param process input process
+     * @param costFactor cost factor
      */
     public CostEstimateBaseClass(ProcessSystem process, double costFactor) {
         this(process);

src/main/java/neqsim/processSimulation/processEquipment/ProcessEquipmentBaseClass.java

@@ -60,7 +60,7 @@ public void displayResult() {}
   /**
    * Create deep copy.
    * 
-   * @return
+   * @return a deep copy of the unit operation/process equipment
    */
   public ProcessEquipmentInterface copy() {
     byte[] bytes = SerializationUtils.serialize(this);

src/main/java/neqsim/processSimulation/processEquipment/absorber/SimpleAbsorber.java

@@ -54,7 +54,7 @@ public SimpleAbsorber(StreamInterface inStream1) {
 
     /**
      * 
-     * @param name
+     * @param name name of absorber
      */
     public SimpleAbsorber(String name) {
         super(name);
@@ -65,8 +65,9 @@ public SimpleAbsorber(String name) {
      * Constructor for SimpleAbsorber.
      * </p>
      *
-     * @param name
-     * @param inStream1 a {@link neqsim.processSimulation.processEquipment.stream.StreamInterface} object
+     * @param name name of absorber
+     * @param inStream1 a {@link neqsim.processSimulation.processEquipment.stream.StreamInterface}
+     *        object
      */
     public SimpleAbsorber(String name, StreamInterface inStream1) {
         super(name);

src/main/java/neqsim/processSimulation/processEquipment/absorber/SimpleTEGAbsorber.java

@@ -5,12 +5,10 @@
 import java.text.DecimalFormat;
 import java.text.FieldPosition;
 import java.util.ArrayList;
-
 import javax.swing.JDialog;
 import javax.swing.JFrame;
 import javax.swing.JScrollPane;
 import javax.swing.JTable;
-
 import neqsim.processSimulation.processEquipment.ProcessEquipmentInterface;
 import neqsim.processSimulation.processEquipment.stream.Stream;
 import neqsim.processSimulation.processEquipment.stream.StreamInterface;
@@ -594,7 +592,7 @@ public void runConditionAnalysis(ProcessEquipmentInterface refTEGabsorberloc) {
      * <p>
      * Setter for the field <code>waterInDryGas</code>.
      * </p>
-     *
+     * @param waterInDryGasInput water in dry gas
      */
     public void setWaterInDryGas(double waterInDryGasInput) {
       waterInDryGas = waterInDryGasInput;

src/main/java/neqsim/processSimulation/processEquipment/adsorber/SimpleAdsorber.java

@@ -73,11 +73,7 @@ public SimpleAdsorber(StreamInterface inStream1) {
         outStream[1].run();
     }
 
-    /**
-     * Constructor for SimpleAdsorber.
-     * 
-     * @param name
-     */
+    /** {@inheritDoc} */
     public SimpleAdsorber(String name) {
         super(name);
     }
@@ -87,7 +83,7 @@ public SimpleAdsorber(String name) {
      * Constructor for SimpleAdsorber.
      * </p>
      * 
-     * @param name
+     * @param name name of the unit operation
      * @param inStream1 a {@link neqsim.processSimulation.processEquipment.stream.StreamInterface}
      *        object
      */

src/main/java/neqsim/processSimulation/processEquipment/compressor/Compressor.java

@@ -87,11 +87,7 @@ public Compressor(boolean interpolateMapLookup) {
     this("Compressor", interpolateMapLookup);
   }
 
-  /**
-   * Constructor for Compressor.
-   * 
-   * @param name
-   */
+  /** {@inheritDoc} */
   public Compressor(String name) {
     super(name);
   }
@@ -115,7 +111,7 @@ public Compressor(String name, StreamInterface inletStream) {
    * Constructor for Compressor.
    * </p>
    *
-   * @param name
+   * @param name name of compressor
    * @param interpolateMapLookup a boolean
    */
   public Compressor(String name, boolean interpolateMapLookup) {

src/main/java/neqsim/processSimulation/processEquipment/compressor/StoneWallCurve.java

@@ -2,7 +2,6 @@
 
 import java.util.Arrays;
 import java.util.Objects;
-
 import org.apache.commons.math3.analysis.polynomials.PolynomialFunction;
 import org.apache.commons.math3.fitting.PolynomialCurveFitter;
 import org.apache.commons.math3.fitting.WeightedObservedPoints;
@@ -105,7 +104,7 @@ boolean isActive() {
     }
 
     /**
-     * @param isActive
+     * @param isActive true if stone wall curve should be used for compressor calculations
      */
     void setActive(boolean isActive) {
         this.isActive = isActive;

src/main/java/neqsim/processSimulation/processEquipment/compressor/SurgeCurve.java

@@ -2,7 +2,6 @@
 
 import java.util.Arrays;
 import java.util.Objects;
-
 import org.apache.commons.math3.analysis.polynomials.PolynomialFunction;
 import org.apache.commons.math3.fitting.PolynomialCurveFitter;
 import org.apache.commons.math3.fitting.WeightedObservedPoints;
@@ -111,7 +110,7 @@ boolean isActive() {
     }
 
     /**
-     * @param isActive
+     * @param isActive true if surge curve should be used for compressor calculations
      */
     void setActive(boolean isActive) {
         this.isActive = isActive;

src/main/java/neqsim/processSimulation/processEquipment/distillation/Condenser.java

@@ -18,13 +18,7 @@ public class Condenser extends SimpleTray {
     boolean refluxIsSet = false;
     double duty = 0.0;
 
-    /**
-     * <p>
-     * Constructor for Condenser.
-     * </p>
-     * 
-     * @param name
-     */
+    /** {@inheritDoc} */
     public Condenser(String name) {
         super(name);
     }

src/main/java/neqsim/processSimulation/processEquipment/distillation/Reboiler.java

@@ -23,7 +23,7 @@ public class Reboiler extends neqsim.processSimulation.processEquipment.distilla
      * Constructor for Reboiler.
      * </p>
      * 
-     * @param name
+     * @param name name of unit operation
      */
     public Reboiler(String name) {
         super(name);

src/main/java/neqsim/processSimulation/processEquipment/distillation/SimpleTray.java

@@ -25,7 +25,7 @@ public class SimpleTray extends neqsim.processSimulation.processEquipment.mixer.
      * Constructor for SimpleTray.
      * </p>
      * 
-     * @param name
+     * @param name name of tray
      */
     public SimpleTray(String name) {
         super(name);

src/main/java/neqsim/processSimulation/processEquipment/distillation/VLSolidTray.java

@@ -24,7 +24,7 @@ public class VLSolidTray extends SimpleTray {
      * Constructor for VLSolidTray.
      * </p>
      * 
-     * @param name
+     * @param name name of tray
      */
     public VLSolidTray(String name) {
         super(name);

src/main/java/neqsim/processSimulation/processEquipment/expander/Expander.java

@@ -41,7 +41,7 @@ public Expander(StreamInterface inletStream) {
     /**
      * Constructor for Expander.
      * 
-     * @param name
+     * @param name name of unit operation
      */
     public Expander(String name) {
         super(name);

src/main/java/neqsim/processSimulation/processEquipment/expander/ExpanderOld.java

@@ -57,7 +57,7 @@ public ExpanderOld(StreamInterface inletStream) {
   /**
    * Constructor for ExpanderOld.
    * 
-   * @param name
+   * @param name name of expander
    */
   public ExpanderOld(String name) {
     super(name);

src/main/java/neqsim/processSimulation/processEquipment/filter/CharCoalFilter.java

@@ -29,8 +29,8 @@ public CharCoalFilter(StreamInterface inStream) {
     /**
      * Constructor for CharCoalFilter.
      * 
-     * @param name
-     * @param inStream
+     * @param name name of filter
+     * @param inStream input stream
      */
     public CharCoalFilter(String name, StreamInterface inStream) {
         super(name, inStream);

src/main/java/neqsim/processSimulation/processEquipment/filter/Filter.java

@@ -38,7 +38,7 @@ public Filter(StreamInterface inStream) {
    * Constructor for Filter.
    * </p>
    *
-   * @param name
+   * @param name name of filter
    * @param inStream a {@link neqsim.processSimulation.processEquipment.stream.StreamInterface}
    *        object
    */

src/main/java/neqsim/processSimulation/processEquipment/heatExchanger/Cooler.java

@@ -39,7 +39,7 @@ public Cooler(StreamInterface inStream) {
     /**
      * Constructor for Cooler.
      * 
-     * @param name
+     * @param name name of cooler
      */
     public Cooler(String name) {
         super(name);

src/main/java/neqsim/processSimulation/processEquipment/heatExchanger/HeatExchanger.java

@@ -80,7 +80,7 @@ public HeatExchanger(StreamInterface inStream1, StreamInterface inStream2) {
     /**
      * Constructor for HeatExchanger.
      * 
-     * @param name
+     * @param name name of heat exchanger
      */
     public HeatExchanger(String name) {
       super(name);
@@ -89,8 +89,8 @@ public HeatExchanger(String name) {
     /**
      * Constructor for HeatExchanger.
      * 
-     * @param name
-     * @param inStream1
+     * @param name name of heat exchanger
+     * @param inStream1 input stream
      */
     public HeatExchanger(String name, StreamInterface inStream1) {
         this(name);
@@ -103,9 +103,9 @@ public HeatExchanger(String name, StreamInterface inStream1) {
     /**
      * Constructor for HeatExchanger.
      * 
-     * @param name
-     * @param inStream1
-     * @param inStream2
+     * @param name name of heat exchanger
+     * @param inStream1 input stream 1
+     * @param inStream2 input stream 2
      */
     public HeatExchanger(String name, StreamInterface inStream1, StreamInterface inStream2) {
       this(name);
@@ -553,7 +553,7 @@ String getFlowArrangement() {
     }
 
     /**
-     * @param flowArrangement
+     * @param flowArrangement name of flow arrangement
      */
     void setFlowArrangement(String flowArrangement) {
         this.flowArrangement = flowArrangement;

src/main/java/neqsim/processSimulation/processEquipment/heatExchanger/Heater.java

@@ -58,7 +58,7 @@ public Heater(StreamInterface inStream) {
   /**
    * Constructor for Heater.
    * 
-   * @param name
+   * @param name name of heater
    */
   public Heater(String name) {
     super(name);

src/main/java/neqsim/processSimulation/processEquipment/heatExchanger/NeqHeater.java

@@ -43,7 +43,7 @@ public NeqHeater(StreamInterface inStream) {
     /**
      * Constructor for NeqHeater.
      * 
-     * @param name
+     * @param name name of heater
      */
     public NeqHeater(String name) {
         super(name);
@@ -52,8 +52,8 @@ public NeqHeater(String name) {
     /**
      * Constructor for NeqHeater.
      * 
-     * @param name
-     * @param inStream
+     * @param name name of heater
+     * @param inStream input stream
      */
     public NeqHeater(String name, StreamInterface inStream) {
         super(name, inStream);

src/main/java/neqsim/processSimulation/processEquipment/heatExchanger/ReBoiler.java

@@ -48,8 +48,8 @@ public ReBoiler(StreamInterface inStream) {
      * Constructor for ReBoiler.
      * </p>
      * 
-     * @param name
-     * @param stream a {@link neqsim.processSimulation.processEquipment.stream.StreamInterface}
+     * @param name name of reboiler
+     * @param inStream a {@link neqsim.processSimulation.processEquipment.stream.StreamInterface}
      *        object
      */
     public ReBoiler(String name, StreamInterface inStream) {

src/main/java/neqsim/processSimulation/processEquipment/pipeline/AdiabaticPipe.java

@@ -55,7 +55,7 @@ public AdiabaticPipe(StreamInterface inStream) {
     /**
      * Constructor for AdiabaticPipe.
      * 
-     * @param name
+     * @param name name of pipe
      */
     public AdiabaticPipe(String name) {
         super(name);
@@ -64,8 +64,8 @@ public AdiabaticPipe(String name) {
     /**
      * Constructor for AdiabaticPipe.
      * 
-     * @param name
-     * @param inStream
+     * @param name name of pipe
+     * @param inStream input stream
      */
     public AdiabaticPipe(String name, StreamInterface inStream) {
         this(name);

src/main/java/neqsim/processSimulation/processEquipment/pipeline/AdiabaticTwoPhasePipe.java

@@ -58,7 +58,7 @@ public AdiabaticTwoPhasePipe(StreamInterface inStream) {
     /**
      * Constructor for AdiabaticTwoPhasePipe.
      * 
-     * @param name
+     * @param name name of pipe
      */
     public AdiabaticTwoPhasePipe(String name) {
         super(name);
@@ -67,8 +67,8 @@ public AdiabaticTwoPhasePipe(String name) {
     /**
      * Constructor for AdiabaticTwoPhasePipe.
      * 
-     * @param name
-     * @param inStream
+     * @param name name of pipe
+     * @param inStream input stream
      */
     public AdiabaticTwoPhasePipe(String name, StreamInterface inStream) {
         super(name, inStream);