Pulling all pending Bukkit-JavaDoc changes
A special thanks goes to @aerouk for almost all of the changes found here. By: Wesley Wolfe <weswolf@aol.com>
This commit is contained in:
@@ -4,7 +4,8 @@ import java.awt.Image;
|
||||
|
||||
/**
|
||||
* Represents a canvas for drawing to a map. Each canvas is associated with a
|
||||
* specific {@link MapRenderer} and represents that renderer's layer on the map.
|
||||
* specific {@link MapRenderer} and represents that renderer's layer on the
|
||||
* map.
|
||||
*/
|
||||
public interface MapCanvas {
|
||||
|
||||
|
||||
@@ -146,9 +146,10 @@ public final class MapCursor {
|
||||
}
|
||||
|
||||
/**
|
||||
* Represents the standard types of map cursors. More may be made available
|
||||
* by texture packs - the value is used by the client as an index in the
|
||||
* file './misc/mapicons.png' from minecraft.jar or from a texture pack.
|
||||
* Represents the standard types of map cursors. More may be made
|
||||
* available by texture packs - the value is used by the client as an
|
||||
* index in the file './misc/mapicons.png' from minecraft.jar or from a
|
||||
* texture pack.
|
||||
*/
|
||||
public enum Type {
|
||||
WHITE_POINTER(0),
|
||||
|
||||
@@ -33,14 +33,16 @@ public class MapFont {
|
||||
* Get the sprite for a given character.
|
||||
*
|
||||
* @param ch The character to get the sprite for.
|
||||
* @return The CharacterSprite associated with the character, or null if there is none.
|
||||
* @return The CharacterSprite associated with the character, or null if
|
||||
* there is none.
|
||||
*/
|
||||
public CharacterSprite getChar(char ch) {
|
||||
return chars.get(ch);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the width of the given text as it would be rendered using this font.
|
||||
* Get the width of the given text as it would be rendered using this
|
||||
* font.
|
||||
*
|
||||
* @param text The text.
|
||||
* @return The width in pixels.
|
||||
@@ -70,7 +72,8 @@ public class MapFont {
|
||||
* Check whether the given text is valid.
|
||||
*
|
||||
* @param text The text.
|
||||
* @return True if the string contains only defined characters, false otherwise.
|
||||
* @return True if the string contains only defined characters, false
|
||||
* otherwise.
|
||||
*/
|
||||
public boolean isValid(String text) {
|
||||
for (int i = 0; i < text.length(); ++i) {
|
||||
|
||||
@@ -181,7 +181,8 @@ public final class MapPalette {
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the index of the closest matching color in the palette to the given color.
|
||||
* Get the index of the closest matching color in the palette to the given
|
||||
* color.
|
||||
*
|
||||
* @param r The red component of the color.
|
||||
* @param b The blue component of the color.
|
||||
@@ -195,7 +196,8 @@ public final class MapPalette {
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the index of the closest matching color in the palette to the given color.
|
||||
* Get the index of the closest matching color in the palette to the given
|
||||
* color.
|
||||
*
|
||||
* @param color The Color to match.
|
||||
* @return The index in the palette.
|
||||
|
||||
@@ -10,7 +10,8 @@ public abstract class MapRenderer {
|
||||
private boolean contextual;
|
||||
|
||||
/**
|
||||
* Initialize the map renderer base to be non-contextual. See {@link #isContextual()}.
|
||||
* Initialize the map renderer base to be non-contextual. See {@link
|
||||
* #isContextual()}.
|
||||
*/
|
||||
public MapRenderer() {
|
||||
this(false);
|
||||
@@ -19,7 +20,8 @@ public abstract class MapRenderer {
|
||||
/**
|
||||
* Initialize the map renderer base with the given contextual status.
|
||||
*
|
||||
* @param contextual Whether the renderer is contextual. See {@link #isContextual()}.
|
||||
* @param contextual Whether the renderer is contextual. See {@link
|
||||
* #isContextual()}.
|
||||
*/
|
||||
public MapRenderer(boolean contextual) {
|
||||
this.contextual = contextual;
|
||||
|
||||
Reference in New Issue
Block a user