javadoc fixes for jdk11 (#534)

equinor · Sep 30, 2022 · ca00355 · ca00355
1 parent 69855a6
commit ca00355
Show file tree

Hide file tree

Showing 8 changed files with 22 additions and 12 deletions.
diff --git a/src/main/java/neqsim/processSimulation/processEquipment/compressor/Compressor.java b/src/main/java/neqsim/processSimulation/processEquipment/compressor/Compressor.java
@@ -93,7 +93,7 @@ public Compressor(boolean interpolateMapLookup) {
   /**
    * Constructor for Compressor.
    *
-   * @param name
+   * @param name Name of compressor
    */
   public Compressor(String name) {
     super(name);
@@ -118,7 +118,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) {

diff --git a/src/main/java/neqsim/processSimulation/processEquipment/heatExchanger/HeatExchanger.java b/src/main/java/neqsim/processSimulation/processEquipment/heatExchanger/HeatExchanger.java
@@ -223,6 +223,8 @@ public void setOutStream(int streamNumber, StreamInterface outStream) {
    * <p>
    * runSpecifiedStream.
    * </p>
+   *
+   * @param id UUID of run
    */
   public void runSpecifiedStream(UUID id) {
     int nonOutStreamSpecifiedStreamNumber = 0;

diff --git a/src/main/java/neqsim/processSimulation/processEquipment/stream/Stream.java b/src/main/java/neqsim/processSimulation/processEquipment/stream/Stream.java
@@ -426,6 +426,7 @@ public void runTransient(double dt, UUID id) {
    * </p>
    *
    * @param dt a double
+   * @param id UUID of run
    */
   public void runController(double dt, UUID id) {
     if (hasController) {

diff --git a/src/main/java/neqsim/standards/gasQuality/Standard_ISO6976.java b/src/main/java/neqsim/standards/gasQuality/Standard_ISO6976.java
@@ -79,7 +79,7 @@ public class Standard_ISO6976 extends neqsim.standards.Standard
   /**
    * Constructor for Standard_ISO6976.
    *
-   * @param thermoSystem
+   * @param thermoSystem SystemInterface to base object on
    */
   public Standard_ISO6976(SystemInterface thermoSystem) {
     this("Standard_ISO6976",
@@ -92,7 +92,7 @@ public Standard_ISO6976(SystemInterface thermoSystem) {
    *
    * @param name Name of standard
    * @param description Description of standard
-   * @param thermoSystem
+   * @param thermoSystem SystemInterface to base object on
    */
   public Standard_ISO6976(String name, String description, SystemInterface thermoSystem) {
     super(name, description, thermoSystem);

diff --git a/src/main/java/neqsim/thermo/FluidCreator.java b/src/main/java/neqsim/thermo/FluidCreator.java
@@ -7,7 +7,7 @@
  * <p>
  * FluidCreator class.
  * </p>
- * 
+ *
  * @author esol
  * @version $Id: $Id
  */
@@ -19,6 +19,8 @@ public class FluidCreator {
   public static String thermoMixingRule = "classic";
 
   /**
+   * Create SystemInterface.
+   *
    * @param componentNames name of components to be added to a fluid
    * @return a fluid object (SystemInterface)
    */
@@ -32,6 +34,8 @@ public static SystemInterface create(String[] componentNames) {
   }
 
   /**
+   * Create SystemInterface.
+   *
    * @param componentNames name of components to be added to a fluid
    * @param flowrate flow rate
    * @param unit unit of flow rate
@@ -46,9 +50,12 @@ public static SystemInterface create(String[] componentNames, double[] flowrate,
     return fluid.createFluid(componentNames, flowrate, unit);
   }
 
-  /**"
-   * @param fluidType fluid type can  be "dry gas", "water", "air", "gas condensate", "combustion air"...
-   * @return
+  /**
+   * Create SystemInterface.
+   *
+   * @param fluidType fluid type can be "dry gas", "water", "air", "gas condensate", "combustion
+   *        air"...
+   * @return a fluid object (SystemInterface)
    */
   public static SystemInterface create(String fluidType) {
     Fluid fluid = new Fluid();

diff --git a/src/main/java/neqsim/thermo/component/ComponentInterface.java b/src/main/java/neqsim/thermo/component/ComponentInterface.java
@@ -1504,9 +1504,7 @@ public void Finit(PhaseInterface phase, double temperature, double pressure,
   public double getChemicalPotentialdV(PhaseInterface phase);
 
   /**
-   * <p>
-   * getPureComponentHeatOfVaporization.
-   * </p>
+   * Calculates the pure component heat of vaporization in J/mol.
    *
    * @param temperature a double
    * @return a double

diff --git a/src/main/java/neqsim/thermo/system/SystemInterface.java b/src/main/java/neqsim/thermo/system/SystemInterface.java
@@ -2491,6 +2491,7 @@ public void setImplementedCompositionDeriativesofFugacity(
    * @param charFlowrate an array of {@link double} objects
    * @param molarMass an array of {@link double} objects
    * @param relativedensity an array of {@link double} objects
+   * @param lastIsPlusFraction True if last fraction is a Plus fraction
    */
   public void addOilFractions(String[] charNames, double[] charFlowrate, double[] molarMass,
       double[] relativedensity, boolean lastIsPlusFraction);
@@ -2504,6 +2505,7 @@ public void addOilFractions(String[] charNames, double[] charFlowrate, double[]
    * @param charFlowrate an array of {@link double} objects
    * @param molarMass an array of {@link double} objects
    * @param relativedensity an array of {@link double} objects
+   * @param lastIsPlusFraction True if last fraction is a Plus fraction
    * @param lumpComponents True if component should be lumped
    * @param numberOfPseudoComponents number of pseudo components
    */

diff --git a/src/main/java/neqsim/thermo/system/SystemThermo.java b/src/main/java/neqsim/thermo/system/SystemThermo.java
@@ -2225,7 +2225,7 @@ public final PhaseInterface getLiquidPhase() {
     return null;
   }
 
-  /** @{inheritdoc} */
+  /** {@inheritDoc} */
   @Override
   public boolean isPhase(int i) {
     if (i > phaseArray.length) {