Javadoc fixes.

This commit is contained in:
Michael Bayne
2015-03-14 09:43:11 -07:00
parent 7dcb90c8d3
commit f2eaa55c35
5 changed files with 7 additions and 13 deletions
@@ -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) public ColorRecord getColorRecord (String className, String colorName)
{ {
@@ -41,12 +41,7 @@ package com.threerings.media.image;
* - Changed the 'QUICK' constant to false for better quantization. * - Changed the 'QUICK' constant to false for better quantization.
* - Fixed an integer overflow that caused a bug quantizing large images. * - Fixed an integer overflow that caused a bug quantizing large images.
* *
* <p><p> * <p>Original headers follow:
*
* Original headers follow:
* </pre>
*
*
* *
* An efficient color quantization algorithm, adapted from the C++ * An efficient color quantization algorithm, adapted from the C++
* implementation quantize.c in <a * implementation quantize.c in <a
@@ -29,8 +29,7 @@ public class MathUtil
/** /**
* Bounds the supplied value within the specified range. * Bounds the supplied value within the specified range.
* *
* @return low if value < low, high if value > high and value * @return low if {@code value < low}, high if {@code value > high} and value otherwise.
* otherwise.
*/ */
public static int bound (int low, int value, int high) public static int bound (int low, int value, int high)
{ {
@@ -26,10 +26,10 @@ package com.threerings.miso.client;
public interface MultiTileSprite public interface MultiTileSprite
{ {
/** Returns the number of tiles the sprite occupies along the x-axis. Note that the origin is /** 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 (); public int getBaseWidth ();
/** Returns the number of tiles the sprite occupies along the y-axis. Note that the origin is /** 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 (); public int getBaseHeight ();
} }
@@ -78,8 +78,8 @@ public class ObjectSet
} }
/** /**
* Returns the object with the specified index. The index must & be * Returns the object with the specified index. The index must be between {@code 0} and
* between <code>0</code> and {@link #size}<code>-1</code>. * {@link #size}{@code - 1}.
*/ */
public ObjectInfo get (int index) public ObjectInfo get (int index)
{ {