mirror of
https://github.com/plexusorg/Plex-FAWE.git
synced 2025-06-11 20:13:55 +00:00
Cleaned up Javadoc comments.
This commit is contained in:
@ -49,7 +49,7 @@ public class CuboidRegion implements Region {
|
||||
/**
|
||||
* Get the lower point of the cuboid.
|
||||
*
|
||||
* @return
|
||||
* @return min point
|
||||
*/
|
||||
@Override
|
||||
public Point getMinimumPoint() {
|
||||
@ -61,7 +61,7 @@ public class CuboidRegion implements Region {
|
||||
/**
|
||||
* Get the upper point of the cuboid.
|
||||
*
|
||||
* @return
|
||||
* @return max point
|
||||
*/
|
||||
@Override
|
||||
public Point getMaximumPoint() {
|
||||
@ -73,7 +73,7 @@ public class CuboidRegion implements Region {
|
||||
/**
|
||||
* Get the number of blocks in the region.
|
||||
*
|
||||
* @return
|
||||
* @return number of blocks
|
||||
*/
|
||||
public int getSize() {
|
||||
Point min = getMinimumPoint();
|
||||
@ -87,7 +87,7 @@ public class CuboidRegion implements Region {
|
||||
/**
|
||||
* Get X-size.
|
||||
*
|
||||
* @return
|
||||
* @return width
|
||||
*/
|
||||
public int getWidth() {
|
||||
Point min = getMinimumPoint();
|
||||
@ -99,7 +99,7 @@ public class CuboidRegion implements Region {
|
||||
/**
|
||||
* Get Y-size.
|
||||
*
|
||||
* @return
|
||||
* @return height
|
||||
*/
|
||||
public int getHeight() {
|
||||
Point min = getMinimumPoint();
|
||||
@ -111,7 +111,7 @@ public class CuboidRegion implements Region {
|
||||
/**
|
||||
* Get Z-size.
|
||||
*
|
||||
* @return
|
||||
* @return length
|
||||
*/
|
||||
public int getLength() {
|
||||
Point min = getMinimumPoint();
|
||||
@ -123,7 +123,7 @@ public class CuboidRegion implements Region {
|
||||
/**
|
||||
* Get the iterator.
|
||||
*
|
||||
* @return
|
||||
* @return iterator of Points
|
||||
*/
|
||||
public Iterator<Point> iterator() {
|
||||
throw new UnsupportedOperationException("Not implemented");
|
||||
|
@ -131,7 +131,9 @@ public final class Point {
|
||||
/**
|
||||
* Adds two points.
|
||||
*
|
||||
* @param other
|
||||
* @param x
|
||||
* @param y
|
||||
* @param z
|
||||
* @return New point
|
||||
*/
|
||||
public Point add(double x, double y, double z) {
|
||||
@ -141,7 +143,9 @@ public final class Point {
|
||||
/**
|
||||
* Adds two points.
|
||||
*
|
||||
* @param other
|
||||
* @param x
|
||||
* @param y
|
||||
* @param z
|
||||
* @return New point
|
||||
*/
|
||||
public Point add(int x, int y, int z) {
|
||||
@ -151,7 +155,7 @@ public final class Point {
|
||||
/**
|
||||
* Adds points.
|
||||
*
|
||||
* @param other
|
||||
* @param others
|
||||
* @return New point
|
||||
*/
|
||||
public Point add(Point ... others) {
|
||||
@ -178,7 +182,9 @@ public final class Point {
|
||||
/**
|
||||
* Subtract two points.
|
||||
*
|
||||
* @param other
|
||||
* @param x
|
||||
* @param y
|
||||
* @param z
|
||||
* @return New point
|
||||
*/
|
||||
public Point subtract(double x, double y, double z) {
|
||||
@ -188,7 +194,9 @@ public final class Point {
|
||||
/**
|
||||
* Subtract two points.
|
||||
*
|
||||
* @param other
|
||||
* @param x
|
||||
* @param y
|
||||
* @param z
|
||||
* @return New point
|
||||
*/
|
||||
public Point subtract(int x, int y, int z) {
|
||||
@ -198,7 +206,7 @@ public final class Point {
|
||||
/**
|
||||
* Subtract points.
|
||||
*
|
||||
* @param other
|
||||
* @param others
|
||||
* @return New point
|
||||
*/
|
||||
public Point subtract(Point ... others) {
|
||||
@ -225,7 +233,9 @@ public final class Point {
|
||||
/**
|
||||
* Multiply two points.
|
||||
*
|
||||
* @param other
|
||||
* @param x
|
||||
* @param y
|
||||
* @param z
|
||||
* @return New point
|
||||
*/
|
||||
public Point multiply(double x, double y, double z) {
|
||||
@ -235,7 +245,9 @@ public final class Point {
|
||||
/**
|
||||
* Multiply two points.
|
||||
*
|
||||
* @param other
|
||||
* @param x
|
||||
* @param y
|
||||
* @param z
|
||||
* @return New point
|
||||
*/
|
||||
public Point multiply(int x, int y, int z) {
|
||||
@ -245,7 +257,7 @@ public final class Point {
|
||||
/**
|
||||
* Multiply points.
|
||||
*
|
||||
* @param other
|
||||
* @param others
|
||||
* @return New point
|
||||
*/
|
||||
public Point multiply(Point ... others) {
|
||||
@ -272,7 +284,9 @@ public final class Point {
|
||||
/**
|
||||
* Divide two points.
|
||||
*
|
||||
* @param other
|
||||
* @param x
|
||||
* @param y
|
||||
* @param z
|
||||
* @return New point
|
||||
*/
|
||||
public Point divide(double x, double y, double z) {
|
||||
@ -282,7 +296,9 @@ public final class Point {
|
||||
/**
|
||||
* Divide two points.
|
||||
*
|
||||
* @param other
|
||||
* @param x
|
||||
* @param y
|
||||
* @param z
|
||||
* @return New point
|
||||
*/
|
||||
public Point divide(int x, int y, int z) {
|
||||
@ -295,7 +311,7 @@ public final class Point {
|
||||
* @param x
|
||||
* @param y
|
||||
* @param z
|
||||
* @return
|
||||
* @return point
|
||||
*/
|
||||
public static Point toBlockPoint(double x, double y, double z) {
|
||||
return new Point((int)Math.floor(x),
|
||||
@ -307,7 +323,7 @@ public final class Point {
|
||||
* Checks if another object is equivalent.
|
||||
*
|
||||
* @param obj
|
||||
* @return
|
||||
* @return whether the other object is equivalent
|
||||
*/
|
||||
@Override
|
||||
public boolean equals(Object obj) {
|
||||
@ -322,7 +338,7 @@ public final class Point {
|
||||
/**
|
||||
* Gets the hash code.
|
||||
*
|
||||
* @return
|
||||
* @return hash code
|
||||
*/
|
||||
@Override
|
||||
public int hashCode() {
|
||||
|
@ -27,37 +27,37 @@ public interface Region extends Iterable<Point> {
|
||||
/**
|
||||
* Get the lower point of a region.
|
||||
*
|
||||
* @return
|
||||
* @return min. point
|
||||
*/
|
||||
public Point getMinimumPoint();
|
||||
/**
|
||||
* Get the upper point of a region.
|
||||
*
|
||||
* @return
|
||||
* @return max. point
|
||||
*/
|
||||
public Point getMaximumPoint();
|
||||
/**
|
||||
* Get the number of blocks in the region.
|
||||
*
|
||||
* @return
|
||||
* @return number of blocks
|
||||
*/
|
||||
public int getSize();
|
||||
/**
|
||||
* Get X-size.
|
||||
*
|
||||
* @return
|
||||
* @return width
|
||||
*/
|
||||
public int getWidth();
|
||||
/**
|
||||
* Get Y-size.
|
||||
*
|
||||
* @return
|
||||
* @return height
|
||||
*/
|
||||
public int getHeight();
|
||||
/**
|
||||
* Get Z-size.
|
||||
*
|
||||
* @return
|
||||
* @return length
|
||||
*/
|
||||
public int getLength();
|
||||
}
|
||||
|
Reference in New Issue
Block a user