Parcourir la source

Harmonize some comments with public SquidLib

smelc il y a 7 ans
Parent
commit
1d074df4e0

+ 1 - 1
squidlib-util/src/main/java/squidpony/squidgrid/mapping/Rectangle.java

@@ -224,7 +224,7 @@ public interface Rectangle extends Zone {
 		 *            An array of (at least) size 4, to hold the 4 corners. It
 		 *            is returned, except if {@code null} or too small, in which
 		 *            case a fresh array is returned.
-		 * @return
+		 * @return {@code buf}, if it had length of at least 4, or a new 4-element array; it contains this Rectangle's 4 corners
 		 */
 		public static Coord[] getAll4Corners(Rectangle r, Coord[] buf) {
 			final Coord[] result = buf == null || buf.length < 4 ? new Coord[4] : buf;

+ 11 - 7
squidlib-util/src/main/java/squidpony/squidgrid/zone/Zone.java

@@ -97,13 +97,15 @@ public interface Zone extends Serializable, Iterable<Coord> {
 
 	/**
 	 * @return The distance between the leftmost cell and the rightmost cell, or
-	 *         anything negative if {@code this} zone is empty.
+	 *         anything negative if {@code this} zone is empty; may be 0 if all cells
+	 *         are in one vertical line.
 	 */
 	int getWidth();
 
 	/**
 	 * @return The distance between the topmost cell and the lowest cell, or
-	 *         anything negative if {@code this} zone is empty.
+	 *         anything negative if {@code this} zone is empty; may be 0 if all cells
+	 *         are in one horizontal line.
 	 */
 	int getHeight();
 
@@ -114,14 +116,16 @@ public interface Zone extends Serializable, Iterable<Coord> {
 	double getDiagonal();
 
 	/**
-	 * @param smallestOrBiggest
+	 * @param smallestOrBiggest if true, finds the smallest x-coordinate value;
+	 *                          if false, finds the biggest.
 	 * @return The x-coordinate of the Coord within {@code this} that has the
 	 *         smallest (or biggest) x-coordinate. Or -1 if the zone is empty.
 	 */
 	int x(boolean smallestOrBiggest);
 
 	/**
-	 * @param smallestOrBiggest
+	 * @param smallestOrBiggest if true, finds the smallest y-coordinate value;
+	 *                          if false, finds the biggest.
 	 * @return The y-coordinate of the Coord within {@code this} that has the
 	 *         smallest (or biggest) y-coordinate. Or -1 if the zone is empty.
 	 */
@@ -132,7 +136,7 @@ public interface Zone extends Serializable, Iterable<Coord> {
      */
     List<Coord> getAll();
 
-	/** @return {@code this} shifted by {@code c} */
+	/** @return {@code this} shifted by {@code (c.x,c.y)} */
 	Zone translate(Coord c);
 
 	/** @return {@code this} shifted by {@code (x,y)} */
@@ -149,8 +153,8 @@ public interface Zone extends Serializable, Iterable<Coord> {
 
 	/**
 	 * @return A variant of {@code this} where cells adjacent to {@code this}
-	 *         have been added (i.e. it's {@code this} plus
-	 *         {@link #getExternalBorder()}).
+	 *         (orthogonally or diagonally) have been added (i.e. it's {@code this}
+	 *         plus {@link #getExternalBorder()}).
 	 */
 	Zone extend();