From 24aec1403fc9e3f1868e66b90bc83dacdb07ca06 Mon Sep 17 00:00:00 2001 From: Juuz <6596629+Juuxel@users.noreply.github.com> Date: Thu, 27 May 2021 18:17:25 +0300 Subject: Javadoc improvements --- src/main/java/io/github/cottonmc/cotton/gui/math/Vec2i.java | 2 ++ .../io/github/cottonmc/cotton/gui/widget/data/Insets.java | 12 ++++++++---- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/src/main/java/io/github/cottonmc/cotton/gui/math/Vec2i.java b/src/main/java/io/github/cottonmc/cotton/gui/math/Vec2i.java index 4515c09..7ee8f0d 100644 --- a/src/main/java/io/github/cottonmc/cotton/gui/math/Vec2i.java +++ b/src/main/java/io/github/cottonmc/cotton/gui/math/Vec2i.java @@ -4,6 +4,8 @@ package io.github.cottonmc.cotton.gui.math; * An immutable, two-dimensional int vector. * This record can be used to represent positions on the screen. * + * @param x the horizontal component + * @param y the vertical component * @since 4.0.0 */ public record Vec2i(int x, int y) { diff --git a/src/main/java/io/github/cottonmc/cotton/gui/widget/data/Insets.java b/src/main/java/io/github/cottonmc/cotton/gui/widget/data/Insets.java index 4ceb13f..782cf74 100644 --- a/src/main/java/io/github/cottonmc/cotton/gui/widget/data/Insets.java +++ b/src/main/java/io/github/cottonmc/cotton/gui/widget/data/Insets.java @@ -4,6 +4,10 @@ package io.github.cottonmc.cotton.gui.widget.data; * The layout insets of a panel. The insets describe how many pixels should be around the panel's contents. * For example, root panels have 7 pixels around their contents, which is set via {@link #ROOT_PANEL}. * + * @param top the top (Y-) inset size + * @param left the left (X-) inset size + * @param bottom the bottom (Y+) inset size + * @param right the right (X+) inset size * @since 4.0.0 */ public record Insets(int top, int left, int bottom, int right) { @@ -20,10 +24,10 @@ public record Insets(int top, int left, int bottom, int right) { /** * Constructs layout insets. * - * @param top the top (-Y) inset size - * @param left the left (-X) inset size - * @param bottom the bottom (+Y) inset size - * @param right the right (+X) inset size + * @param top the top (Y-) inset size + * @param left the left (X-) inset size + * @param bottom the bottom (Y+) inset size + * @param right the right (X+) inset size */ public Insets { if (top < 0) throw new IllegalArgumentException("top cannot be negative, found " + top); -- cgit