Fix javadoc related errors

This commit is contained in:
RednedEpic 2020-04-22 01:03:46 -05:00
parent 7ca1d1bea6
commit e8bf8ff2a0
5 changed files with 18 additions and 6 deletions

View file

@ -120,6 +120,9 @@ public class Entity {
}
/**
* Despawns the entity
*
* @param session The GeyserSession
* @return can be deleted
*/
public boolean despawnEntity(GeyserSession session) {
@ -234,6 +237,7 @@ public class Entity {
/**
* x = Pitch, y = HeadYaw, z = Yaw
* @return the bedrock rotation
*/
public Vector3f getBedrockRotation() {
return Vector3f.from(rotation.getY(), rotation.getZ(), rotation.getX());

View file

@ -46,7 +46,7 @@ public class BlockStateValues {
/**
* Determines if the block state contains Bedrock block information
* @param entry The String -> JsonNode map used in BlockTranslator
* @param entry The String to JsonNode map used in BlockTranslator
* @param javaBlockState the Java Block State of the block
*/
public static void storeBlockStateValues(Map.Entry<String, JsonNode> entry, BlockState javaBlockState) {

View file

@ -30,16 +30,22 @@ import java.lang.annotation.RetentionPolicy;
@Retention(value = RetentionPolicy.RUNTIME)
public @interface BlockEntity {
/**
* Whether to delay the sending of the block entity
* @return the delay for when sending the block entity
*/
boolean delay();
/**
* The block entity name
* @return the name of the block entity
*/
String name();
/**
* The search term used in BlockTranslator
* @return the search term used in BlockTranslator
*/
String regex();
}

View file

@ -54,6 +54,8 @@ public class Objective {
/**
* /!\ This method is made for temporary objectives until the real objective is received
* @param scoreboard the scoreboard
* @param objectiveName the name of the objective
*/
public Objective(Scoreboard scoreboard, String objectiveName) {
this(scoreboard);

View file

@ -43,7 +43,7 @@ public class FileUtils {
* @param src File to load
* @param valueType Class to load file into
* @return The data as the given class
* @throws IOException
* @throws IOException if the config could not be loaded
*/
public static <T> T loadConfig(File src, Class<T> valueType) throws IOException {
ObjectMapper objectMapper = new ObjectMapper(new YAMLFactory());
@ -56,7 +56,7 @@ public class FileUtils {
* @param name File and resource name
* @param fallback Formatting callback
* @return File handle of the specified file
* @throws IOException
* @throws IOException if the file failed to copy from resource
*/
public static File fileOrCopiedFromResource(String name, Function<String, String> fallback) throws IOException {
return fileOrCopiedFromResource(new File(name), name, fallback);
@ -69,7 +69,7 @@ public class FileUtils {
* @param name Name of the resource get if needed
* @param format Formatting callback
* @return File handle of the specified file
* @throws IOException
* @throws IOException if the file failed to copy from resource
*/
public static File fileOrCopiedFromResource(File file, String name, Function<String, String> format) throws IOException {
if (!file.exists()) {
@ -98,7 +98,7 @@ public class FileUtils {
*
* @param file File to write to
* @param data Data to write to the file
* @throws IOException
* @throws IOException if the file failed to write
*/
public static void writeFile(File file, char[] data) throws IOException {
if (!file.exists()) {
@ -120,7 +120,7 @@ public class FileUtils {
*
* @param name File path to write to
* @param data Data to write to the file
* @throws IOException
* @throws IOException if the file failed to write
*/
public static void writeFile(String name, char[] data) throws IOException {
writeFile(new File(name), data);