Skip to content

Commit

Permalink
doc: fix javadoc @link to type double causing javadoc warnings (#1057)
Browse files Browse the repository at this point in the history
* doc: fix javadoc link
  • Loading branch information
asmfstatoil authored Aug 2, 2024
1 parent ae61f63 commit 1275400
Show file tree
Hide file tree
Showing 128 changed files with 741 additions and 851 deletions.
10 changes: 5 additions & 5 deletions src/main/java/neqsim/MathLib/generalMath/TDMAsolve.java
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,11 @@ private TDMAsolve() {}
* solve.
* </p>
*
* @param a an array of {@link double} objects
* @param b an array of {@link double} objects
* @param c an array of {@link double} objects
* @param r an array of {@link double} objects
* @return an array of {@link double} objects
* @param a an array of type double
* @param b an array of type double
* @param c an array of type double
* @param r an array of type double
* @return an array of type double
*/
public static double[] solve(double[] a, double[] b, double[] c, double[] r) {
int length = a.length;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ public static double fugcoefDiffPres(ComponentInterface component, PhaseInterfac
* @param numberOfComponents a int
* @param temperature a double
* @param pressure a double
* @param pt the PhaseType of the phase.
* @param pt the PhaseType of the phase
* @return a double
*/
public static double fugcoefDiffTemp(ComponentInterface component, PhaseInterface phase,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ public void setOrder(int o) {
* setConstants.
* </p>
*
* @param constants an array of {@link double} objects
* @param constants an array of type double
*/
public void setConstants(double[] constants) {
System.arraycopy(constants, 0, polyConstants, 0, constants.length);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ public BasePVTsimulation(SystemInterface tempSystem) {
* Setter for the field <code>experimentalData</code>.
* </p>
*
* @param expData an array of {@link double} objects
* @param expData an array of type double
*/
public void setExperimentalData(double[][] expData) {
experimentalData = expData;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -396,8 +396,8 @@ public double getSaturationIsoThermalCompressibility() {
* setTemperaturesAndPressures.
* </p>
*
* @param temperature an array of {@link double} objects
* @param pressure an array of {@link double} objects
* @param temperature an array of type double
* @param pressure an array of type double
*/
public void setTemperaturesAndPressures(double[] temperature, double[] pressure) {
this.pressures = pressure;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@ public ConstantVolumeDepletion(SystemInterface tempSystem) {
* setTemperaturesAndPressures.
* </p>
*
* @param temperature an array of {@link double} objects
* @param pressure an array of {@link double} objects
* @param temperature an array of type double
* @param pressure an array of type double
*/
public void setTemperaturesAndPressures(double[] temperature, double[] pressure) {
this.pressure = pressure;
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/neqsim/PVTsimulation/simulation/DensitySim.java
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@ public DensitySim(SystemInterface tempSystem) {
* setTemperaturesAndPressures.
* </p>
*
* @param temperature an array of {@link double} objects
* @param pressure an array of {@link double} objects
* @param temperature an array of type double
* @param pressure an array of type double
*/
public void setTemperaturesAndPressures(double[] temperature, double[] pressure) {
this.pressure = pressure;
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/neqsim/PVTsimulation/simulation/GOR.java
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@ public GOR(SystemInterface tempSystem) {
* setTemperaturesAndPressures.
* </p>
*
* @param temperature an array of {@link double} objects
* @param pressure an array of {@link double} objects
* @param temperature an array of type double
* @param pressure an array of type double
*/
public void setTemperaturesAndPressures(double[] temperature, double[] pressure) {
this.pressure = pressure;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@ public SeparatorTest(SystemInterface tempSystem) {
* setSeparatorConditions.
* </p>
*
* @param temperature an array of {@link double} objects
* @param pressure an array of {@link double} objects
* @param temperature an array of type double
* @param pressure an array of type double
*/
public void setSeparatorConditions(double[] temperature, double[] pressure) {
this.pressure = pressure;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ public void setInjectionGas(SystemInterface injectionGas) {
* setCummulativeMolePercentGasInjected.
* </p>
*
* @param gasInjected an array of {@link double} objects
* @param gasInjected an array of type double
*/
public void setCummulativeMolePercentGasInjected(double[] gasInjected) {
this.gasInjected = gasInjected;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@ public ViscositySim(SystemInterface tempSystem) {
* setTemperaturesAndPressures.
* </p>
*
* @param temperature an array of {@link double} objects
* @param pressure an array of {@link double} objects
* @param temperature an array of type double
* @param pressure an array of type double
*/
public void setTemperaturesAndPressures(double[] temperature, double[] pressure) {
this.pressure = pressure;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@ public ViscosityWaxOilSim(SystemInterface tempSystem) {
* setTemperaturesAndPressures.
* </p>
*
* @param temperature an array of {@link double} objects
* @param pressure an array of {@link double} objects
* @param temperature an array of type double
* @param pressure an array of type double
*/
public void setTemperaturesAndPressures(double[] temperature, double[] pressure) {
this.pressure = pressure;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,8 @@ public WaxFractionSim(SystemInterface tempSystem) {
* setTemperaturesAndPressures.
* </p>
*
* @param temperature an array of {@link double} objects
* @param pressure an array of {@link double} objects
* @param temperature an array of type double
* @param pressure an array of type double
*/
public void setTemperaturesAndPressures(double[] temperature, double[] pressure) {
this.pressure = pressure;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -294,7 +294,7 @@ public boolean hasReactions() {
* calcNVector.
* </p>
*
* @return an array of {@link double} objects
* @return an array of type double
*/
public double[] calcNVector() {
double[] nvec = new double[components.length];
Expand All @@ -310,7 +310,7 @@ public double[] calcNVector() {
* calcBVector.
* </p>
*
* @return an array of {@link double} objects
* @return an array of type double
*/
public double[] calcBVector() {
Matrix tempA = new Matrix(Amatrix);
Expand All @@ -329,7 +329,7 @@ public double[] calcBVector() {
* </p>
*
* @param phase a int
* @return an array of {@link double} objects
* @return an array of type double
*/
public double[] calcChemRefPot(int phase) {
double[] referencePotentials = new double[components.length];
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,10 +74,10 @@ public ChemEq() {
*
* @param T a double
* @param P a double
* @param A_matrix an array of {@link double} objects
* @param n_mol an array of {@link double} objects
* @param chem_ref an array of {@link double} objects
* @param b_element an array of {@link double} objects
* @param A_matrix an array of type double
* @param n_mol an array of type double
* @param chem_ref an array of type double
* @param b_element an array of type double
*/
public ChemEq(double T, double P, double[][] A_matrix, double[] n_mol, double[] chem_ref,
double[] b_element) {
Expand Down Expand Up @@ -116,7 +116,7 @@ public ChemEq(double T, double P, double[][] A_matrix, double[] n_mol, double[]
* Constructor for ChemEq.
* </p>
*
* @param A_matrix an array of {@link double} objects
* @param A_matrix an array of type double
*/
public ChemEq(double[][] A_matrix) {
this.A_matrix = A_matrix;
Expand All @@ -129,7 +129,7 @@ public ChemEq(double[][] A_matrix) {
*
* @param T a double
* @param P a double
* @param A_matrix an array of {@link double} objects
* @param A_matrix an array of type double
*/
public ChemEq(double T, double P, double[][] A_matrix) {
this.T = T;
Expand Down Expand Up @@ -286,7 +286,7 @@ public double step() {
* innerStep.
* </p>
*
* @param n_omega an array of {@link double} objects
* @param n_omega an array of type double
* @param check a int
* @param step a double
* @return a double
Expand Down Expand Up @@ -322,8 +322,8 @@ public double innerStep(double[] n_omega, int check, double step) {
*
* @param T a double
* @param P a double
* @param n_mol an array of {@link double} objects
* @param chem_ref an array of {@link double} objects
* @param n_mol an array of type double
* @param chem_ref an array of type double
*/
public void solve(double T, double P, double[] n_mol, double[] chem_ref) {
this.T = T;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,8 @@ public class ChemicalEquilibrium implements java.io.Serializable {
* Constructor for ChemicalEquilibrium.
* </p>
*
* @param A_matrix an array of {@link double} objects
* @param b_element an array of {@link double} objects
* @param A_matrix an array of type double
* @param b_element an array of type double
* @param system a {@link neqsim.thermo.system.SystemInterface} object
* @param components an array of {@link neqsim.thermo.component.ComponentInterface} objects
* @param phase a int
Expand Down Expand Up @@ -377,7 +377,7 @@ public void printComp() {
* getMoles.
* </p>
*
* @return an array of {@link double} objects
* @return an array of type double
*/
public double[] getMoles() {
return n_mol;
Expand Down Expand Up @@ -482,7 +482,7 @@ public double step() {
* </p>
*
* @param i a int
* @param n_omega an array of {@link double} objects
* @param n_omega an array of type double
* @param check a int
* @param step a double
* @param test a boolean
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ public class LinearProgrammingChemicalEquilibrium
* Constructor for LinearProgrammingChemicalEquilibrium.
* </p>
*
* @param chemRefPot an array of {@link double} objects
* @param chemRefPot an array of type double
* @param components an array of {@link neqsim.thermo.component.ComponentInterface} objects
* @param elements an array of {@link java.lang.String} objects
* @param operations a {@link neqsim.chemicalReactions.ChemicalReactionOperations} object
Expand Down Expand Up @@ -112,7 +112,7 @@ public LinearProgrammingChemicalEquilibrium(double[] chemRefPot, ComponentInterf
* calcA.
* </p>
*
* @return an array of {@link double} objects
* @return an array of type double
*/
public double[][] calcA() {
int A_size = components.length - operations.getReactionList().getChemicalReactionList().size();
Expand Down Expand Up @@ -151,7 +151,7 @@ public double[][] calcA() {
* getA.
* </p>
*
* @return an array of {@link double} objects
* @return an array of type double
*/
public double[][] getA() {
return Amatrix;
Expand All @@ -162,7 +162,7 @@ public double[][] getA() {
* getRefPot.
* </p>
*
* @return an array of {@link double} objects
* @return an array of type double
*/
public double[] getRefPot() {
return chemRefPot;
Expand Down Expand Up @@ -329,10 +329,10 @@ public void calcx(Matrix atemp, Matrix lagrangeTemp) {
* </p>
*
* @param system a {@link neqsim.thermo.system.SystemInterface} object
* @param bVector an array of {@link double} objects
* @param bVector an array of type double
* @param inertMoles a double
* @param phase a int
* @return an array of {@link double} objects
* @return an array of type double
*/
public double[] generateInitialEstimates(SystemInterface system, double[] bVector,
double inertMoles, int phase) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ public class ChemicalReaction extends NamedBaseClass
*
* @param name a {@link java.lang.String} object
* @param names an array of {@link java.lang.String} objects
* @param stocCoefs an array of {@link double} objects
* @param K an array of {@link double} objects
* @param stocCoefs an array of type double
* @param K an array of type double
* @param r a double
* @param activationEnergy a double
* @param refT a double
Expand Down Expand Up @@ -135,7 +135,7 @@ public double getRateFactor(PhaseInterface phase) {
* Getter for the field <code>stocCoefs</code>.
* </p>
*
* @return an array of {@link double} objects
* @return an array of type double
*/
public double[] getStocCoefs() {
return this.stocCoefs;
Expand Down Expand Up @@ -244,8 +244,8 @@ public double calcK(neqsim.thermo.system.SystemInterface system, int phaseNumb)
*
* @param phase a {@link neqsim.thermo.phase.PhaseInterface} object
* @param components an array of {@link neqsim.thermo.component.ComponentInterface} objects
* @param Amatrix an array of {@link double} objects
* @param chemRefPot an array of {@link double} objects
* @param Amatrix an array of type double
* @param chemRefPot an array of type double
*/
public void initMoleNumbers(PhaseInterface phase, ComponentInterface[] components,
double[][] Amatrix, double[] chemRefPot) {
Expand Down
Loading

0 comments on commit 1275400

Please sign in to comment.