Skip to content

Commit 40165db

Browse files
Overhaul annotation usage in the map builder (#40)
* Improve documentation * Remove experimental annotation and change used annotation in the spawn method --------- Co-authored-by: theEvilReaper <theEvilReaper@users.noreply.github.com>
1 parent c2681ac commit 40165db

File tree

2 files changed

+3
-5
lines changed

2 files changed

+3
-5
lines changed

src/main/java/net/theevilreaper/aves/map/BaseMap.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ public BaseMap() {
3333

3434
/**
3535
* Creates a new reference from the {@link BaseMap}.
36-
* It requires all values which are needed to create a map.
36+
* It requires all values that are needed to create a map.
3737
*
3838
* @param name the name from the map
3939
* @param builders the builders from the map
@@ -83,7 +83,7 @@ public boolean equals(Object o) {
8383
}
8484

8585
/**
86-
* Returns a hash value from some data which are provided by the object.
86+
* Returns a hash value from some data that are provided by the object.
8787
* In general, the hash relies on the unique data.
8888
* For the basic implementation that is only the name of the map.
8989
*

src/main/java/net/theevilreaper/aves/map/BaseMapBuilder.java

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
package net.theevilreaper.aves.map;
22

33
import net.minestom.server.coordinate.Pos;
4-
import org.jetbrains.annotations.ApiStatus;
54
import org.jetbrains.annotations.NotNull;
65
import org.jetbrains.annotations.Nullable;
76

@@ -17,7 +16,6 @@
1716
* @version 1.0.0
1817
* @since 1.9.0
1918
*/
20-
@ApiStatus.Experimental
2119
public class BaseMapBuilder {
2220

2321
protected final List<String> builders;
@@ -89,7 +87,7 @@ protected BaseMapBuilder(@NotNull BaseMap baseMap) {
8987
* @param spawn the position where the map will spawn
9088
* @return the current instance of {@link BaseMapBuilder} for method chaining
9189
*/
92-
public @NotNull BaseMapBuilder spawn(@NotNull Pos spawn) {
90+
public @NotNull BaseMapBuilder spawn(@Nullable Pos spawn) {
9391
this.spawn = spawn;
9492
return this;
9593
}

0 commit comments

Comments
 (0)