Improve the documentation of getTypeID().

It might be confused with getIndex(), so emphasize the fact that it 
returns the data type ID of the object, and not its index.
This commit is contained in:
Kristian S. Stangeland 2013-11-18 22:25:05 +01:00
parent 3d6cfbf1e1
commit ba6c6e5abf

View File

@ -172,6 +172,43 @@ public class WrappedWatchableObject {
/** /**
* Retrieve the type ID of a watchable object. * Retrieve the type ID of a watchable object.
* <p>
* <table border=1>
* <tbody>
* <tr>
* <th>Type ID</th>
* <th>Data Type</th>
* </tr>
* <tr>
* <td>0</td>
* <td>Byte</td>
* </tr>
* <tr>
* <td>1</td>
* <td>Short</td>
* </tr>
* <tr>
* <td>2</td>
* <td>Int</td>
* </tr>
* <tr>
* <td>3</td>
* <td>Float</td>
* </tr>
* <tr>
* <td>4</td>
* <td>{@link String}</td>
* </tr>
* <tr>
* <td>5</td>
* <td>{@link org.bukkit.inventory.ItemStack ItemStack}</td>
* </tr>
* <tr>
* <td>6<sup>*</sup></td>
* <td>{@link com.comphenix.protocol.wrappers.ChunkPosition ChunkPosition}</td>
* </tr>
* </tbody>
* </table>
* @return Type ID that identifies the type of the value. * @return Type ID that identifies the type of the value.
* @throws FieldAccessException Reflection failed. * @throws FieldAccessException Reflection failed.
*/ */
@ -181,6 +218,7 @@ public class WrappedWatchableObject {
/** /**
* Set the type ID of a watchable object. * Set the type ID of a watchable object.
* @see {@link #getTypeID()} for more information.
* @param id - the new ID. * @param id - the new ID.
* @throws FieldAccessException Reflection failed. * @throws FieldAccessException Reflection failed.
*/ */