From 10703082eda2daaac6c94047fd38458acd903043 Mon Sep 17 00:00:00 2001 From: sk89q Date: Mon, 11 Oct 2010 08:56:19 -0700 Subject: [PATCH] Cleaned up Javadoc comments. --- src/CuboidClipboard.java | 12 +++---- src/EditSession.java | 24 ++++++------- src/ScriptMinecraftContext.java | 4 +-- src/WorldEdit.java | 6 ++-- src/WorldEditPlayer.java | 14 ++++---- src/WorldEditSession.java | 19 +++++----- src/com/sk89q/worldedit/CuboidRegion.java | 14 ++++---- src/com/sk89q/worldedit/Point.java | 44 +++++++++++++++-------- src/com/sk89q/worldedit/Region.java | 12 +++---- 9 files changed, 81 insertions(+), 68 deletions(-) diff --git a/src/CuboidClipboard.java b/src/CuboidClipboard.java index df9c3c24d..01d34890a 100644 --- a/src/CuboidClipboard.java +++ b/src/CuboidClipboard.java @@ -54,7 +54,7 @@ public class CuboidClipboard { /** * Get the width (X-direction) of the clipboard. * - * @return + * @return width */ public int getWidth() { return (int)(max.getX() - min.getX() + 1); @@ -63,7 +63,7 @@ public class CuboidClipboard { /** * Get the length (Z-direction) of the clipboard. * - * @return + * @return length */ public int getLength() { return (int)(max.getZ() - min.getZ() + 1); @@ -72,7 +72,7 @@ public class CuboidClipboard { /** * Get the height (Y-direction) of the clipboard. * - * @return + * @return height */ public int getHeight() { return (int)(max.getY() - min.getY() + 1); @@ -98,7 +98,7 @@ public class CuboidClipboard { * Paste from the clipboard. * * @param editSession - * @param origin Position to paste it from + * @param newOrigin Position to paste it from * @param noAir True to not paste air * @throws MaxChangedBlocksException */ @@ -148,7 +148,7 @@ public class CuboidClipboard { * @param xm * @param ym * @param zm - * @short count + * @param count * @param noAir * @param moveOrigin move the origin * @throws MaxChangedBlocksException @@ -234,7 +234,7 @@ public class CuboidClipboard { * * @param path * @param origin - * @return + * @return clipboard * @throws SchematicException * @throws IOException */ diff --git a/src/EditSession.java b/src/EditSession.java index 6d11c4ddf..36c7cde9d 100644 --- a/src/EditSession.java +++ b/src/EditSession.java @@ -237,7 +237,7 @@ public class EditSession { * Get the maximum number of blocks that can be changed. -1 will be * returned if disabled. * - * @return + * @return block change limit */ public int getBlockChangeLimit() { return maxBlocks; @@ -258,7 +258,7 @@ public class EditSession { /** * Returns queue status. * - * @return + * @return whether the queue is enabled */ public boolean isQueueEnabled() { return queued; @@ -302,7 +302,7 @@ public class EditSession { * @param blockType * @param radius * @param depth - * @return + * @return number of blocks affected */ public int fillXZ(int x, int z, Point origin, int blockType, int radius, int depth) throws MaxChangedBlocksException { @@ -361,9 +361,9 @@ public class EditSession { * Remove blocks above. * * @param pos - * @param size, + * @param size * @param height - * @return + * @return number of blocks affected */ public int removeAbove(Point pos, int size, int height) throws MaxChangedBlocksException { @@ -391,9 +391,9 @@ public class EditSession { * Remove blocks below. * * @param pos - * @param size, + * @param size * @param height - * @return + * @return number of blocks affected */ public int removeBelow(Point pos, int size, int height) throws MaxChangedBlocksException { @@ -422,7 +422,7 @@ public class EditSession { * * @param region * @param blockType - * @return + * @return number of blocks affected * @throws MaxChangedBlocksException */ public int setBlocks(Region region, int blockType) @@ -462,7 +462,7 @@ public class EditSession { * @param region * @param fromBlockType -1 for non-air * @param toBlockType - * @return + * @return number of blocks affected * @throws MaxChangedBlocksException */ public int replaceBlocks(Region region, int fromBlockType, int toBlockType) @@ -510,7 +510,7 @@ public class EditSession { * * @param region * @param blockType - * @return + * @return number of blocks affected * @throws MaxChangedBlocksException */ public int makeCuboidFaces(Region region, int blockType) @@ -549,10 +549,8 @@ public class EditSession { * Overlays a layer of blocks over a cuboid area. * * @param region - * @param upperY - * @param lowerY * @param blockType - * @return + * @return number of blocks affected * @throws MaxChangedBlocksException */ public int overlayCuboidBlocks(Region region, int blockType) diff --git a/src/ScriptMinecraftContext.java b/src/ScriptMinecraftContext.java index 24300606c..a57d7eede 100644 --- a/src/ScriptMinecraftContext.java +++ b/src/ScriptMinecraftContext.java @@ -44,7 +44,7 @@ public class ScriptMinecraftContext { * @param z * @param blockType * @throws MaxChangedBlocksException - * @return + * @return whether the block was changed */ public boolean setBlock(int x, int y, int z, int blockType) throws MaxChangedBlocksException { @@ -57,7 +57,7 @@ public class ScriptMinecraftContext { * @param x * @param y * @param z - * @return + * @return block type ID */ public int getBlock(int x, int y, int z) { return editSession.getBlock(x, y, z); diff --git a/src/WorldEdit.java b/src/WorldEdit.java index 95e24f79b..8a9f9ef8d 100644 --- a/src/WorldEdit.java +++ b/src/WorldEdit.java @@ -212,7 +212,7 @@ public class WorldEdit extends Plugin { /** * Called on right click. * - * @param player + * @param modPlayer * @param blockPlaced * @param blockClicked * @param itemInHand @@ -264,9 +264,9 @@ public class WorldEdit extends Plugin { /** * - * @param player + * @param modPlayer * @param split - * @return + * @return whether the command was processed */ @Override public boolean onCommand(Player modPlayer, String[] split) { diff --git a/src/WorldEditPlayer.java b/src/WorldEditPlayer.java index 29458c907..c83e416eb 100644 --- a/src/WorldEditPlayer.java +++ b/src/WorldEditPlayer.java @@ -47,7 +47,7 @@ public class WorldEditPlayer { /** * Get the point of the block that is being stood upon. * - * @return + * @return point */ public Point getBlockOn() { return Point.toBlockPoint(player.getX(), player.getY() - 1, player.getZ()); @@ -56,7 +56,7 @@ public class WorldEditPlayer { /** * Get the point of the block that is being stood in. * - * @return + * @return point */ public Point getBlockIn() { return Point.toBlockPoint(player.getX(), player.getY(), player.getZ()); @@ -65,7 +65,7 @@ public class WorldEditPlayer { /** * Get the player's position. * - * @return + * @return point */ public Point getPosition() { return new Point(player.getX(), player.getY(), player.getZ()); @@ -74,7 +74,7 @@ public class WorldEditPlayer { /** * Get the player's view pitch. * - * @return + * @return pitch */ public double getPitch() { return player.getPitch(); @@ -83,7 +83,7 @@ public class WorldEditPlayer { /** * Get the player's view yaw. * - * @return + * @return yaw */ public double getYaw() { return player.getRotation(); @@ -176,7 +176,7 @@ public class WorldEditPlayer { * Returns true if equal. * * @param other - * @return + * @return whether the other object is equivalent */ @Override public boolean equals(Object other) { @@ -190,7 +190,7 @@ public class WorldEditPlayer { /** * Gets the hash code. * - * @return + * @return hash code */ @Override public int hashCode() { diff --git a/src/WorldEditSession.java b/src/WorldEditSession.java index e69b3ac85..4ba495dee 100644 --- a/src/WorldEditSession.java +++ b/src/WorldEditSession.java @@ -45,8 +45,6 @@ public class WorldEditSession { /** * Get the edit session. - * - * @return */ public void remember(EditSession editSession) { // Don't store anything if no changes were made @@ -119,7 +117,7 @@ public class WorldEditSession { /** * Gets defined position 1. * - * @return + * @return position 1 * @throws IncompleteRegionException */ public Point getPos1() throws IncompleteRegionException { @@ -139,7 +137,7 @@ public class WorldEditSession { /** * Gets position 2. * - * @return + * @return position 2 * @throws IncompleteRegionException */ public Point getPos2() throws IncompleteRegionException { @@ -159,7 +157,7 @@ public class WorldEditSession { /** * Get the region. * - * @return + * @return region * @throws IncompleteRegionException */ public Region getRegion() throws IncompleteRegionException { @@ -172,7 +170,7 @@ public class WorldEditSession { /** * Gets the clipboard. * - * @return + * @return clipboard, may be null */ public CuboidClipboard getClipboard() { return clipboard; @@ -190,7 +188,7 @@ public class WorldEditSession { /** * See if tool control is enabled. * - * @return + * @return true if enabled */ public boolean isToolControlEnabled() { return toolControl; @@ -199,7 +197,7 @@ public class WorldEditSession { /** * Change tool control setting. * - * @param + * @param toolControl */ public void setToolControl(boolean toolControl) { this.toolControl = toolControl; @@ -222,7 +220,7 @@ public class WorldEditSession { /** * Returns true if the tool has been double clicked. * - * @return + * @return true if double clicked */ public boolean hasToolBeenDoubleClicked() { return System.currentTimeMillis() - lastToolClick < 500; @@ -237,7 +235,8 @@ public class WorldEditSession { /** * Get the maximum number of blocks that can be changed in an edit session. - * @return + * + * @return block change limit */ public int getBlockChangeLimit() { return maxBlocksChanged; diff --git a/src/com/sk89q/worldedit/CuboidRegion.java b/src/com/sk89q/worldedit/CuboidRegion.java index 921bcb314..1f21de256 100644 --- a/src/com/sk89q/worldedit/CuboidRegion.java +++ b/src/com/sk89q/worldedit/CuboidRegion.java @@ -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 iterator() { throw new UnsupportedOperationException("Not implemented"); diff --git a/src/com/sk89q/worldedit/Point.java b/src/com/sk89q/worldedit/Point.java index 4e0a4e5db..ab24efde2 100644 --- a/src/com/sk89q/worldedit/Point.java +++ b/src/com/sk89q/worldedit/Point.java @@ -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() { diff --git a/src/com/sk89q/worldedit/Region.java b/src/com/sk89q/worldedit/Region.java index 0eabd7d63..a77173fff 100644 --- a/src/com/sk89q/worldedit/Region.java +++ b/src/com/sk89q/worldedit/Region.java @@ -27,37 +27,37 @@ public interface Region extends Iterable { /** * 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(); }