From f2eaa55c351eb972f4c72abae53f5b5c84c81f4d Mon Sep 17 00:00:00 2001 From: Michael Bayne Date: Sat, 14 Mar 2015 09:43:11 -0700 Subject: [PATCH] Javadoc fixes. --- .../java/com/threerings/media/image/ColorPository.java | 2 +- .../src/main/java/com/threerings/media/image/Quantize.java | 7 +------ core/src/main/java/com/threerings/media/util/MathUtil.java | 3 +-- .../java/com/threerings/miso/client/MultiTileSprite.java | 4 ++-- core/src/main/java/com/threerings/miso/util/ObjectSet.java | 4 ++-- 5 files changed, 7 insertions(+), 13 deletions(-) diff --git a/core/src/main/java/com/threerings/media/image/ColorPository.java b/core/src/main/java/com/threerings/media/image/ColorPository.java index 0776ca78..c600cce3 100644 --- a/core/src/main/java/com/threerings/media/image/ColorPository.java +++ b/core/src/main/java/com/threerings/media/image/ColorPository.java @@ -428,7 +428,7 @@ public class ColorPository implements Serializable } /** - * Looks up the requested color record by class & color names. + * Looks up the requested color record by class and color names. */ public ColorRecord getColorRecord (String className, String colorName) { diff --git a/core/src/main/java/com/threerings/media/image/Quantize.java b/core/src/main/java/com/threerings/media/image/Quantize.java index 01af85b6..34392114 100644 --- a/core/src/main/java/com/threerings/media/image/Quantize.java +++ b/core/src/main/java/com/threerings/media/image/Quantize.java @@ -41,12 +41,7 @@ package com.threerings.media.image; * - Changed the 'QUICK' constant to false for better quantization. * - Fixed an integer overflow that caused a bug quantizing large images. * - *

- * - * Original headers follow: - * - * - * + *

Original headers follow: * * An efficient color quantization algorithm, adapted from the C++ * implementation quantize.c in high and value - * otherwise. + * @return low if {@code value < low}, high if {@code value > high} and value otherwise. */ public static int bound (int low, int value, int high) { diff --git a/core/src/main/java/com/threerings/miso/client/MultiTileSprite.java b/core/src/main/java/com/threerings/miso/client/MultiTileSprite.java index be79c015..6239bd68 100644 --- a/core/src/main/java/com/threerings/miso/client/MultiTileSprite.java +++ b/core/src/main/java/com/threerings/miso/client/MultiTileSprite.java @@ -26,10 +26,10 @@ package com.threerings.miso.client; public interface MultiTileSprite { /** Returns the number of tiles the sprite occupies along the x-axis. Note that the origin is - * defined to be the tile with the maximal x & y coordinates. */ + * defined to be the tile with the maximal x and y coordinates. */ public int getBaseWidth (); /** Returns the number of tiles the sprite occupies along the y-axis. Note that the origin is - * defined to be the tile with the maximal x & y coordinates. */ + * defined to be the tile with the maximal x and y coordinates. */ public int getBaseHeight (); } diff --git a/core/src/main/java/com/threerings/miso/util/ObjectSet.java b/core/src/main/java/com/threerings/miso/util/ObjectSet.java index f920b386..c52978ac 100644 --- a/core/src/main/java/com/threerings/miso/util/ObjectSet.java +++ b/core/src/main/java/com/threerings/miso/util/ObjectSet.java @@ -78,8 +78,8 @@ public class ObjectSet } /** - * Returns the object with the specified index. The index must & be - * between 0 and {@link #size}-1. + * Returns the object with the specified index. The index must be between {@code 0} and + * {@link #size}{@code - 1}. */ public ObjectInfo get (int index) {