Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

javadoc fixes for jdk11 #534

Merged
merged 3 commits into from
Sep 30, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ public Compressor(boolean interpolateMapLookup) {
/**
* Constructor for Compressor.
*
* @param name
* @param name Name of compressor
*/
public Compressor(String name) {
super(name);
Expand All @@ -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) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -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);
Expand Down
15 changes: 11 additions & 4 deletions src/main/java/neqsim/thermo/FluidCreator.java
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
* <p>
* FluidCreator class.
* </p>
*
*
* @author esol
* @version $Id: $Id
*/
Expand All @@ -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)
*/
Expand All @@ -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
Expand All @@ -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();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions src/main/java/neqsim/thermo/system/SystemInterface.java
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand All @@ -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
*/
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/neqsim/thermo/system/SystemThermo.java
Original file line number Diff line number Diff line change
Expand Up @@ -2225,7 +2225,7 @@ public final PhaseInterface getLiquidPhase() {
return null;
}

/** @{inheritdoc} */
/** {@inheritDoc} */
@Override
public boolean isPhase(int i) {
if (i > phaseArray.length) {
Expand Down