Skip to content

Commit b1cea34

Browse files
committed
Change some java doc
1 parent 51d58ae commit b1cea34

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

src/main/java/dev/wolfieboy09/qstorage/api/energy/ExtendedEnergyStorage.java

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,18 @@
99
public class ExtendedEnergyStorage extends EnergyStorage {
1010
private final BlockEntity be;
1111
/**
12-
* Creates a new ExtendedEnergyStorage instance with the specified capacity.
12+
* Creates a new {@link ExtendedEnergyStorage} instance with the specified capacity.
1313
*
1414
* @param capacity the maximum amount of energy that can be stored
1515
* @param be the block entity associated with this storage
1616
*/
17-
public ExtendedEnergyStorage(int capacity,BlockEntity be) {
17+
public ExtendedEnergyStorage(int capacity, BlockEntity be) {
1818
super(capacity);
1919
this.be = be;
2020
}
2121

2222
/**
23-
* Creates a new ExtendedEnergyStorage instance with the specified capacity and maximum transfer amount.
23+
* Creates a new {@link ExtendedEnergyStorage} instance with the specified capacity and maximum transfer amount.
2424
*
2525
* @param capacity the maximum amount of energy that can be stored
2626
* @param maxTransfer the maximum amount of energy that can be transferred in a single operation
@@ -30,14 +30,22 @@ public ExtendedEnergyStorage(int capacity, int maxTransfer, BlockEntity be) {
3030
super(capacity, maxTransfer);
3131
this.be = be;
3232
}
33-
33+
34+
/**
35+
* Creates a new {@link ExtendedEnergyStorage} instance with the specified capacity, maximum receive amount, and maximum extract amount.
36+
*
37+
* @param capacity The maximum amount of energy that can be stored
38+
* @param maxReceive The maximum amount of energy that can be received in a single operation
39+
* @param maxExtract The maximum amount of energy that can be extracted in a single operation
40+
* @param be The block entity associated with this storage
41+
*/
3442
public ExtendedEnergyStorage(int capacity, int maxReceive, int maxExtract, BlockEntity be) {
3543
super(capacity, maxReceive, maxExtract);
3644
this.be = be;
3745
}
3846

3947
/**
40-
* Creates a new ExtendedEnergyStorage instance with the specified capacity, maximum receive amount, maximum extract amount, and initial energy amount.
48+
* Creates a new {@link ExtendedEnergyStorage} instance with the specified capacity, maximum receive amount, maximum extract amount, and initial energy amount.
4149
*
4250
* @param capacity the maximum amount of energy that can be stored
4351
* @param maxReceive the maximum amount of energy that can be received in a single operation
@@ -53,7 +61,7 @@ public ExtendedEnergyStorage(int capacity, int maxReceive, int maxExtract, int e
5361
/**
5462
* Sets the current energy amount to the specified value, clamping it to the range [0, capacity].
5563
*
56-
* @param energy the new energy amount
64+
* @param energy The new energy amount
5765
*/
5866
public void setEnergy(int energy) {
5967
if(energy < 0)
@@ -117,7 +125,7 @@ public int extractEnergy(int toExtract, boolean simulate) {
117125
}
118126
return toReturn;
119127
}
120-
128+
121129
public void onEnergyChanged() {
122130
this.be.setChanged();
123131
}

0 commit comments

Comments
 (0)