Many javadoc fixes thanks to Celtic Minstrel

By: Dinnerbone <dinnerbone@dinnerbone.com>
This commit is contained in:
Bukkit/Spigot
2011-09-25 02:56:40 +01:00
parent 1968b78a12
commit a8e72bdb91
78 changed files with 380 additions and 335 deletions

View File

@@ -65,9 +65,9 @@ public interface MapCanvas {
* will move down one line and return to the original column, and the text
* color can be changed using sequences such as "§12;", replacing 12 with
* the palette index of the color (see {@link MapPalette}).
* @param map The MapInfo to render to.
* @param x The column to start rendering on.
* @param y The row to start rendering on.
* @param font The font to use.
* @param text The formatted text to render.
*/
public void drawText(int x, int y, MapFont font, String text);

View File

@@ -10,7 +10,7 @@ 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);
@@ -18,7 +18,7 @@ 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;

View File

@@ -26,6 +26,8 @@ public interface MapView {
/**
* Get the scale given the raw value.
* @param value The raw scale
* @return The enum scale, or null for an invalid input
*/
public static Scale valueOf(byte value) {
switch(value) {
@@ -40,6 +42,7 @@ public interface MapView {
/**
* Get the raw value of this scale level.
* @return The scale value
*/
public byte getValue() {
return value;