docfix deprecated functions (#301)

* docfix
equinor · Jan 24, 2022 · 4393436 · 4393436
1 parent 87bf5bf
commit 4393436
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 19 deletions.
diff --git a/src/main/java/neqsim/thermo/characterization/PlusCharacterize.java b/src/main/java/neqsim/thermo/characterization/PlusCharacterize.java
@@ -346,10 +346,13 @@ public int getStartPlus() {
     }
 
     /**
-     * Setter for property startPlus. NB! Deprecated and replaced by firstPlusFractionNumber?
+     * Setter for property firstPlusFractionNumber.
      *
-     * @param startPlus New value of property startPlus.
+     * @param startPlus New value of property firstPlusFractionNumber.
+     * @deprecated use {@link #setFirstPlusFractionNumber(int firstPlusFractionNumber)} instead.
+     * 
      */
+    @Deprecated
     public void setStartPlus(int startPlus) {
         setFirstPlusFractionNumber(startPlus);
     }

diff --git a/src/main/java/neqsim/thermo/system/SystemInterface.java b/src/main/java/neqsim/thermo/system/SystemInterface.java
@@ -392,9 +392,7 @@ public static SystemInterface addFluids(SystemInterface addFluid1, SystemInterfa
     public void setForcePhaseTypes(boolean forcePhaseTypes);
 
     /**
-     * <p>
-     * setEmptyFluid.
-     * </p>
+     * Set the flow rate of all components to zero.
      */
     public void setEmptyFluid();
 
@@ -2143,9 +2141,9 @@ public double calcBeta() throws neqsim.util.exception.IsNaNException,
     public void setPhaseType(int phaseToChange, String phaseTypeName);
 
     /**
-     * <p>
-     * removeMoles.
-     * </p>
+     * Set the flow rate of all components to zero.
+     * 
+     * @deprecated use {@link #setEmptyFluid()} instead.
      */
     public void removeMoles();
 

diff --git a/src/main/java/neqsim/thermo/system/SystemThermo.java b/src/main/java/neqsim/thermo/system/SystemThermo.java
@@ -1299,11 +1299,7 @@ public void removeComponent(String name) {
         numberOfComponents--;
     }
 
-    /**
-     * {@inheritDoc}
-     *
-     * This method set the flow rate of all components to zero.
-     */
+    /** {@inheritDoc} */
     @Override
     public void setEmptyFluid() {
         for (int i = 0; i < getMaxNumberOfPhases(); i++) {
@@ -1312,12 +1308,7 @@ public void setEmptyFluid() {
         totalNumberOfMoles = 0.0;
     }
 
-    /**
-     * {@inheritDoc}
-     *
-     * This method set the flow rate of all components to zero. This method is depreciated - and the
-     * setEmptyFluid method should be used.
-     */
+    /** {@inheritDoc} */
     @Override
     @Deprecated
     public void removeMoles() {