doc: fix javadoc

equinor · Dec 22, 2023 · 2cadc43 · 2cadc43
1 parent 45a72ee
commit 2cadc43
Show file tree

Hide file tree

Showing 10 changed files with 20 additions and 19 deletions.
diff --git a/src/main/java/neqsim/chemicalReactions/ChemicalReactionOperations.java b/src/main/java/neqsim/chemicalReactions/ChemicalReactionOperations.java
@@ -453,6 +453,7 @@ public boolean solveChemEq(int phase, int type) {
         solver = new ChemicalEquilibrium(Amatrix, bVector, system, components, phase);
       } catch (Exception ex) {
         logger.error(ex.getMessage(), ex);
+        // todo: Will this crash below?
       }
       return solver.solve();
     }

diff --git a/...ry/heatMassTransferCalc/finiteVolumeBoundary/fluidBoundarySolver/FluidBoundarySolver.java b/...ry/heatMassTransferCalc/finiteVolumeBoundary/fluidBoundarySolver/FluidBoundarySolver.java
@@ -41,7 +41,7 @@ public FluidBoundarySolver() {}
    * Constructor for FluidBoundarySolver.
    * </p>
    *
-   * @param boundary a {@link FluidBoundarySystemInterface} object
+   * @param boundary a {@link neqsim.fluidMechanics.flowNode.fluidBoundary.heatMassTransferCalc.finiteVolumeBoundary.fluidBoundarySystem.FluidBoundarySystemInterface} object
    */
   public FluidBoundarySolver(FluidBoundarySystemInterface boundary) {
     this.boundary = boundary;
@@ -67,7 +67,7 @@ public FluidBoundarySolver(FluidBoundarySystemInterface boundary) {
    * Constructor for FluidBoundarySolver.
    * </p>
    *
-   * @param boundary a {@link FluidBoundarySystemInterface} * object
+   * @param boundary a {@link neqsim.fluidMechanics.flowNode.fluidBoundary.heatMassTransferCalc.finiteVolumeBoundary.fluidBoundarySystem.FluidBoundarySystemInterface} * object
    * @param reactive a boolean
    */
   public FluidBoundarySolver(FluidBoundarySystemInterface boundary, boolean reactive) {

diff --git a/src/main/java/neqsim/fluidMechanics/flowNode/twoPhaseNode/TwoPhaseFlowNode.java b/src/main/java/neqsim/fluidMechanics/flowNode/twoPhaseNode/TwoPhaseFlowNode.java
@@ -401,6 +401,11 @@ public void update() {
     }
   }
 
+  /**
+   * <p>update.</p>
+   *
+   * @param deltaTime a double
+   */
   public void update(double deltaTime) {
     for (int componentNumber = 0; componentNumber < getBulkSystem().getPhases()[0]
         .getNumberOfComponents(); componentNumber++) {

diff --git a/src/main/java/neqsim/processSimulation/controllerDevice/ControllerDeviceInterface.java b/src/main/java/neqsim/processSimulation/controllerDevice/ControllerDeviceInterface.java
@@ -131,17 +131,21 @@ public default void runTransient(double initResponse, double dt) {
 
   /**
    * <p>
-   * setActive
+   * setActive.
    * </p>
    * Set if controller is active
+   *
+   * @param isActive Set true to make controller active.
    */
   public void setActive(boolean isActive);
 
   /**
    * <p>
-   * isActive
+   * isActive.
    * </p>
    * Specifies if controller is active
+   *
+   * @return a boolean
    */
   public boolean isActive();
 }
diff --git a/src/main/java/neqsim/thermo/ThermodynamicModelTest.java b/src/main/java/neqsim/thermo/ThermodynamicModelTest.java
@@ -424,11 +424,8 @@ public boolean checkNumerically() {
   }
 
   /**
-   * <p>
    * 
-   * @param maxErr Maximum error before test will report failed Set maximum allowed error in model
-   *        check
-   *        </p>
+   * @param maxErr before test will report failed Set maximum allowed error in model check
    */
   public void setMaxError(double maxErr) {
     this.maxError = maxErr;

diff --git a/src/main/java/neqsim/thermo/component/ComponentGEUnifacUMRPRU.java b/src/main/java/neqsim/thermo/component/ComponentGEUnifacUMRPRU.java
@@ -399,7 +399,7 @@ public double getGamma(PhaseInterface phase, int numberOfComponents, double temp
     lngamma = lngammaResidual + lngammaCombinational;
 
     if (Double.isNaN(lngamma)) {
-      logger.error("gamma NaN......");
+      logger.warn("gamma NaN......");
       lngamma = 0.0;
       gamma = 1.0;
       dlngammadt = 0;

diff --git a/src/main/java/neqsim/util/unit/LengthUnit.java b/src/main/java/neqsim/util/unit/LengthUnit.java
@@ -23,8 +23,8 @@ public class LengthUnit extends neqsim.util.unit.BaseUnit {
    * Constructor for LengthUnit.
    * </p>
    * 
-   * @param value
-   * @param name
+   * @param value Numeric value
+   * @param name Name of unit
    */
   public LengthUnit(double value, String name) {
     super(value, name);

diff --git a/src/main/java/neqsim/util/unit/TimeUnit.java b/src/main/java/neqsim/util/unit/TimeUnit.java
@@ -22,8 +22,8 @@ public class TimeUnit extends neqsim.util.unit.BaseUnit {
    * Constructor for TimeUnit.
    * </p>
    * 
-   * @param value
-   * @param name
+   * @param value Numeric value
+   * @param name Name of unit
    */
   public TimeUnit(double value, String name) {
     super(value, name);

diff --git a/src/test/java/neqsim/thermodynamicOperations/flashOps/PHFlashGERG2008Test.java b/src/test/java/neqsim/thermodynamicOperations/flashOps/PHFlashGERG2008Test.java
@@ -28,9 +28,6 @@ void setUp() throws Exception {
     testSystem.initProperties();
   }
 
-  /**
-   * Test method for {@link neqsim.thermodynamicOperations.flashOps.PHFlashGERG2008#run()}.
-   */
   @Test
   void testRun() {
     double[] gergProps = testSystem.getPhase(0).getProperties_GERG2008();

diff --git a/src/test/java/neqsim/thermodynamicOperations/flashOps/PHFlashTest.java b/src/test/java/neqsim/thermodynamicOperations/flashOps/PHFlashTest.java
@@ -31,9 +31,6 @@ void setUp() throws Exception {
     testSystem.setMixingRule("classic");
   }
 
-  /**
-   * Test method for {@link neqsim.thermodynamicOperations.flashOps.PHFlash#run()}.
-   */
   @Test
   void testRun() {
     testOps = new ThermodynamicOperations(testSystem);