docfix: revert

equinor · Mar 1, 2024 · 8f187e4 · 8f187e4
1 parent 1679b80
commit 8f187e4
Show file tree

Hide file tree

Showing 7 changed files with 18 additions and 12 deletions.
diff --git a/src/main/java/neqsim/thermo/component/ComponentElectrolyteCPA.java b/src/main/java/neqsim/thermo/component/ComponentElectrolyteCPA.java
@@ -600,7 +600,7 @@ public double[][] getXsitedni() {
    * </p>
    *
    * @param xNumb a int
-   * @param compIndexi a int
+   * @param compNumbi a int
    * @return a double
    */
   public double getXsitedni(int xNumb, int compNumbi) {

diff --git a/src/main/java/neqsim/thermo/component/ComponentEos.java b/src/main/java/neqsim/thermo/component/ComponentEos.java
@@ -226,6 +226,8 @@ public AttractiveTermInterface getAttractiveTerm() {
   }
 
   /**
+   * Get reduced temperature.
+   * 
    * @param temperature temperature of fluid
    * @return double reduced temperature T/TC
    */
@@ -234,6 +236,10 @@ public AttractiveTermInterface getAttractiveTerm() {
   }
 
   /**
+   * <p>
+   * Get reduced pressure.
+   * </p>
+   *
    * @param pressure pressure in unit bara
    * @return double
    */
@@ -732,8 +738,8 @@ public double getdUdVdnS(PhaseInterface phase) {
    * </p>
    *
    * @param phase a {@link neqsim.thermo.phase.PhaseInterface} object
-   * @param compIndex1 a int
-   * @param compIndex2 a int
+   * @param compNumb1 a int
+   * @param compNumb2 a int
    * @return a double
    */
   public double getdUdndnSV(PhaseInterface phase, int compNumb1, int compNumb2) {

diff --git a/src/main/java/neqsim/thermo/component/ComponentHydrate.java b/src/main/java/neqsim/thermo/component/ComponentHydrate.java
@@ -375,7 +375,7 @@ public double calcCKI(int stucture, int cavityType, PhaseInterface phase) {
    * setRefFug.
    * </p>
    *
-   * @param compIndexm a int
+   * @param compNumbm a int
    * @param val a double
    */
   public void setRefFug(int compNumbm, double val) {

diff --git a/src/main/java/neqsim/thermo/component/ComponentHydrateKluda.java b/src/main/java/neqsim/thermo/component/ComponentHydrateKluda.java
@@ -257,7 +257,7 @@ public double calcCKI(int stucture, int cavityType, PhaseInterface phase) {
    * setRefFug.
    * </p>
    *
-   * @param compIndexm a int
+   * @param compNumbm a int
    * @param val a double
    */
   public void setRefFug(int compNumbm, double val) {

diff --git a/src/main/java/neqsim/thermo/component/ComponentSrkCPA.java b/src/main/java/neqsim/thermo/component/ComponentSrkCPA.java
@@ -602,7 +602,7 @@ public double[][] getXsitedni() {
    * </p>
    *
    * @param xNumb a int
-   * @param compIndexi a int
+   * @param compNumbi a int
    * @return a double
    */
   public double getXsitedni(int xNumb, int compNumbi) {

diff --git a/src/main/java/neqsim/thermo/component/ComponentUMRCPA.java b/src/main/java/neqsim/thermo/component/ComponentUMRCPA.java
@@ -604,7 +604,7 @@ public double[][] getXsitedni() {
    * </p>
    *
    * @param xNumb a int
-   * @param compIndexi a int
+   * @param compNumbi a int
    * @return a double
    */
   public double getXsitedni(int xNumb, int compNumbi) {

diff --git a/src/main/java/neqsim/thermo/phase/PhaseInterface.java b/src/main/java/neqsim/thermo/phase/PhaseInterface.java
@@ -24,12 +24,12 @@ public interface PhaseInterface extends ThermodynamicConstantsInterface, Cloneab
    * addcomponent.
    * </p>
    *
-   * @param component_name Name of component.
+   * @param name Name of component.
    * @param moles Total number of moles of component.
    * @param molesInPhase Number of moles in phase.
-   * @param compnumber Index number of component in phase object component array.
+   * @param compIndex Index number of component in phase object component array.
    */
-  public void addComponent(String name, double moles, double molesInPhase, int compNumber);
+  public void addComponent(String name, double moles, double molesInPhase, int compIndex);
 
   /**
    * <p>
@@ -421,10 +421,10 @@ public void init(double totalNumberOfMoles, int numberOfComponents, int initType
    * removeComponent.
    * </p>
    *
-   * @param component_name Name of component.
+   * @param name Name of component.
    * @param moles Total number of moles of component.
    * @param molesInPhase Number of moles in phase.
-   * @param compnumber Index number of component in phase object component array.
+   * @param compNumber Index number of component in phase object component array.
    */
   public void removeComponent(String name, double moles, double molesInPhase, int compNumber);