Skip to content
This repository was archived by the owner on Dec 21, 2024. It is now read-only.

Commit 2855bd9

Browse files
Applied suggested javadoc changes
Co-authored-by: Mariell <[email protected]>
1 parent d6d5a78 commit 2855bd9

File tree

3 files changed

+3
-6
lines changed

3 files changed

+3
-6
lines changed

src/main/java/io/papermc/lib/features/blockstatesnapshot/BlockStateSnapshotHandler.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,9 @@
1111
* A {@link BlockStateSnapshotHandler} is responsible for getting a {@link BlockState}
1212
* from a {@link Block}. This {@link BlockState} can be a snapshot or not, which depends
1313
* on the Server software that is used or the arguments that are passed.
14-
* <br>
14+
* <p>
1515
* You can use {@link #getBlockState(Block, boolean)} to the actual {@link BlockStateSnapshotResult}
1616
* that holds the {@link BlockState} and a boolean determining whether it was a snapshot or not.
17-
*
1817
*/
1918
@FunctionalInterface
2019
public interface BlockStateSnapshotHandler {

src/main/java/io/papermc/lib/features/blockstatesnapshot/BlockStateSnapshotOptionalSnapshots.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@
1010
* This {@link BlockStateSnapshotHandler} allows the developer to decide whether or not to
1111
* take a snapshot.
1212
* if this handler is used, then the {@link Environment} supports both snapshots and non-snapshots.
13-
*
1413
*/
1514
public class BlockStateSnapshotOptionalSnapshots implements BlockStateSnapshotHandler {
1615

src/main/java/io/papermc/lib/features/blockstatesnapshot/BlockStateSnapshotResult.java

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@
1212
* Objects of this type are the result of {@link PaperLib#getBlockState(Block, boolean)}.
1313
* You can use a {@link BlockStateSnapshotResult} to obtain the actual {@link BlockState} but
1414
* also to determine whether a snapshot was taken or not.
15-
*
1615
*/
1716
public class BlockStateSnapshotResult {
1817

@@ -34,7 +33,7 @@ public BlockStateSnapshotResult(boolean isSnapshot, @Nonnull BlockState state) {
3433
/**
3534
* This method returns whether the corresponding {@link BlockState} is a snapshot or not.
3635
* A {@link BlockState} will be a snapshot if explicitly requested or if the {@link Environment}
37-
* does not allow non-snapshot {@link BlockState BlockStates}.
36+
* does not allow non-snapshot {@link BlockState}s.
3837
*
3938
* @return Whether this {@link BlockState} is a snapshot
4039
*/
@@ -46,7 +45,7 @@ public boolean isSnapshot() {
4645
* This returns the {@link BlockState} that was taken.
4746
* To check if it is a snapshot, see {@link #isSnapshot()}.
4847
*
49-
* @return The taken {@link BlockState}
48+
* @return The captured {@link BlockState}.
5049
*/
5150
@Nonnull
5251
public BlockState getState() {

0 commit comments

Comments
 (0)