fix javadoc

This commit is contained in:
Autumn Lamonte 2022-01-31 06:07:09 -06:00
parent ea4d7bdd08
commit c6d5d2b6a0
5 changed files with 17 additions and 3 deletions

View file

@ -1362,8 +1362,6 @@ public abstract class TWidget implements Comparable<TWidget> {
*
* @param mouseStyle the pointer style string, one of: "default", "none",
* "hand", "text", "move", or "crosshair"
*
* @see #setCustomMousePointer(final MousePointer pointer)
*/
public final void setMouseStyle(final String mouseStyle) {
String styleLower = mouseStyle.toLowerCase();
@ -2437,6 +2435,7 @@ public abstract class TWidget implements Comparable<TWidget> {
* @param y row relative to parent
* @param width width of group
* @param label label to display on the group box
* @return the new radio button group
*/
public final TRadioGroup addRadioGroup(final int x, final int y,
final int width, final String label) {
@ -2944,6 +2943,7 @@ public abstract class TWidget implements Comparable<TWidget> {
* item with arrow/page keys
* @param singleClickAction action to perform when the user clicks on an
* item
* @return the new list
*/
public TList addList(final List<String> strings, final int x,
final int y, final int width, final int height,
@ -2964,6 +2964,7 @@ public abstract class TWidget implements Comparable<TWidget> {
* @param image the image to display
* @param left left column of the image. 0 is the left-most column.
* @param top top row of the image. 0 is the top-most row.
* @return the new image
*/
public final TImage addImage(final int x, final int y,
final int width, final int height, final BufferedImage image,
@ -2983,6 +2984,7 @@ public abstract class TWidget implements Comparable<TWidget> {
* @param left left column of the image. 0 is the left-most column.
* @param top top row of the image. 0 is the top-most row.
* @param clickAction function to call when mouse is pressed
* @return the new image
*/
public final TImage addImage(final int x, final int y,
final int width, final int height, final BufferedImage image,
@ -3002,6 +3004,7 @@ public abstract class TWidget implements Comparable<TWidget> {
* @param animation the animation to display
* @param left left column of the image. 0 is the left-most column.
* @param top top row of the image. 0 is the top-most row.
* @return the new image
*/
public final TImage addImage(final int x, final int y,
final int width, final int height, final Animation animation,
@ -3021,6 +3024,7 @@ public abstract class TWidget implements Comparable<TWidget> {
* @param left left column of the image. 0 is the left-most column.
* @param top top row of the image. 0 is the top-most row.
* @param clickAction function to call when mouse is pressed
* @return the new image
*/
public final TImage addImage(final int x, final int y,
final int width, final int height, final Animation animation,
@ -3038,6 +3042,7 @@ public abstract class TWidget implements Comparable<TWidget> {
* @param y row relative to parent
* @param width width of widget
* @param height height of widget
* @return the new table
*/
public TTableWidget addTable(final int x, final int y, final int width,
final int height) {
@ -3055,6 +3060,7 @@ public abstract class TWidget implements Comparable<TWidget> {
* @param height height of widget
* @param gridColumns number of columns in grid
* @param gridRows number of rows in grid
* @return the new table
*/
public TTableWidget addTable(final int x, final int y, final int width,
final int height, final int gridColumns, final int gridRows) {

View file

@ -92,6 +92,7 @@ public class ImageUtils {
/**
* Check if any pixels in an image have not-0% alpha value.
*
* @param image the image to check
* @return true if every pixel is fully transparent
*/
public static boolean isFullyTransparent(final BufferedImage image) {
@ -119,6 +120,7 @@ public class ImageUtils {
/**
* Check if any pixels in an image have not-100% alpha value.
*
* @param image the image to check
* @return true if every pixel is fully transparent
*/
public static boolean isFullyOpaque(final BufferedImage image) {
@ -152,6 +154,7 @@ public class ImageUtils {
* @param height the height in pixels for the destination image
* @param scale the scaling type
* @param backColor the background color to use for Scale.SCALE
* @return the scaled image
*/
public static BufferedImage scaleImage(final BufferedImage image,
final int width, final int height,

View file

@ -54,6 +54,7 @@ public class Demo7 {
* Main entry point.
*
* @param args Command line arguments
* @throws Exception on error
*/
public static void main(final String [] args) throws Exception {
// This demo will build everything "from the outside".

View file

@ -36,11 +36,15 @@ public interface Pointer {
/**
* Get the hotspot X location relative to the X location of the icon.
*
* @return the X location
*/
public int getHotspotX();
/**
* Get the hotspot Y location relative to the Y location of the icon.
*
* @return the Y location
*/
public int getHotspotY();

View file

@ -181,7 +181,7 @@ public class TackboardItem implements Comparable<TackboardItem> {
/**
* Set the tackboard this item is on.
*
* @param tackboard
* @param tackboard the tackboard
*/
public final void setTackboard(final Tackboard tackboard) {
this.tackboard = tackboard;