From 62e11df7b294ea5580323095e5e30f9013efd495 Mon Sep 17 00:00:00 2001 From: akmsw Date: Mon, 24 Jun 2024 01:30:05 -0300 Subject: [PATCH] fix documentation --- src/main/java/armameeldoparti/utils/common/Constants.java | 2 +- .../utils/common/custom/graphical/CustomArrowButton.java | 4 +--- .../utils/common/custom/graphical/CustomButton.java | 4 +--- .../utils/common/custom/graphical/CustomCheckBox.java | 4 +--- .../utils/common/custom/graphical/CustomComboBox.java | 4 +--- .../utils/common/custom/graphical/CustomLabel.java | 4 +--- .../utils/common/custom/graphical/CustomOptionPaneUI.java | 6 +++--- .../utils/common/custom/graphical/CustomRadioButton.java | 4 +--- .../utils/common/custom/graphical/CustomScrollPane.java | 4 +--- .../utils/common/custom/graphical/CustomSeparator.java | 4 +--- .../utils/common/custom/graphical/CustomSpinner.java | 4 +--- .../utils/common/custom/graphical/CustomTable.java | 4 +--- .../utils/common/custom/graphical/CustomTextArea.java | 5 +---- .../utils/common/custom/graphical/CustomTextField.java | 4 +--- .../utils/common/custom/graphical/CustomToolTip.java | 4 +--- 15 files changed, 17 insertions(+), 44 deletions(-) diff --git a/src/main/java/armameeldoparti/utils/common/Constants.java b/src/main/java/armameeldoparti/utils/common/Constants.java index 5c634da..db30fe0 100644 --- a/src/main/java/armameeldoparti/utils/common/Constants.java +++ b/src/main/java/armameeldoparti/utils/common/Constants.java @@ -12,7 +12,7 @@ import javax.swing.ImageIcon; /** - * Commonly-used and useful constants class. + * Common-use constants class. * * @author Bonino, Francisco Ignacio. * diff --git a/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomArrowButton.java b/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomArrowButton.java index 6982df6..727ad1f 100644 --- a/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomArrowButton.java +++ b/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomArrowButton.java @@ -12,9 +12,7 @@ import javax.swing.plaf.basic.BasicArrowButton; /** - * Custom arrow button class. - * - *

This class is used to instantiate a custom arrow button that fits the overall program aesthetics. + * A custom arrow button that fits the overall program aesthetics. * * @author Bonino, Francisco Ignacio. * diff --git a/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomButton.java b/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomButton.java index 1320924..5c59513 100644 --- a/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomButton.java +++ b/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomButton.java @@ -7,9 +7,7 @@ import javax.swing.JButton; /** - * Custom button class. - * - *

This class is used to instantiate a custom button that fits the overall program aesthetics. + * A custom button that fits the overall program aesthetics. * * @author Bonino, Francisco Ignacio. * diff --git a/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomCheckBox.java b/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomCheckBox.java index e9d5249..4053b71 100644 --- a/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomCheckBox.java +++ b/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomCheckBox.java @@ -4,9 +4,7 @@ import javax.swing.JCheckBox; /** - * Custom checkbox class. - * - *

This class is used to instantiate a custom checkbox that fits the overall program aesthetics. + * A custom checkbox that fits the overall program aesthetics. * * @author Bonino, Francisco Ignacio. * diff --git a/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomComboBox.java b/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomComboBox.java index edda98a..d089a74 100644 --- a/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomComboBox.java +++ b/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomComboBox.java @@ -19,9 +19,7 @@ import javax.swing.plaf.basic.ComboPopup; /** - * Custom combobox class. - * - *

This class is used to instantiate a custom combobox that fits the overall program aesthetics. + * A custom combobox that fits the overall program aesthetics. * * @author Bonino, Francisco Ignacio. * diff --git a/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomLabel.java b/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomLabel.java index 40f0f04..df2bdf9 100644 --- a/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomLabel.java +++ b/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomLabel.java @@ -10,9 +10,7 @@ import javax.swing.border.EmptyBorder; /** - * Custom label class. - * - *

This class is used to instantiate a custom label that fits the overall program aesthetics. + * A custom label that fits the overall program aesthetics. * * @author Bonino, Francisco Ignacio. * diff --git a/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomOptionPaneUI.java b/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomOptionPaneUI.java index 269da0a..df90390 100644 --- a/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomOptionPaneUI.java +++ b/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomOptionPaneUI.java @@ -49,9 +49,9 @@ public static ComponentUI createUI(JComponent component) { // ---------- Protected methods -------------------------------------------------------------------------------------------------------------------- /** - * Creates a button for each string in {@code buttons} and adds then to {@code container}. If {@code buttons} does not contain any string-instance - * object, an array is retrieved using the message type for the dialog. This array contains the strings - * that will be used in the buttons to be placed in the dialog. + * Creates a button for each string in {@code buttons} and adds them to {@code container}. If {@code buttons} does not contain any string-instance + * object, an array is retrieved using the message type for the dialog. This array contains the strings that will be used in the buttons to be + * placed in the dialog. * *

The "java:S1190" and "java:S117" warnings are suppressed since JDK22 allows the use of unnamed variables. * diff --git a/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomRadioButton.java b/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomRadioButton.java index cb303b5..868a2b3 100644 --- a/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomRadioButton.java +++ b/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomRadioButton.java @@ -4,9 +4,7 @@ import javax.swing.JRadioButton; /** - * Custom radio button class. - * - *

This class is used to instantiate a custom radio button that fits the overall program aesthetics. + * A custom radio button that fits the overall program aesthetics. * * @author Bonino, Francisco Ignacio. * diff --git a/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomScrollPane.java b/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomScrollPane.java index c1be8ae..bd1fe12 100644 --- a/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomScrollPane.java +++ b/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomScrollPane.java @@ -13,9 +13,7 @@ import javax.swing.plaf.basic.BasicScrollBarUI; /** - * Custom scroll pane class. - * - *

This class is used to instantiate a custom scroll pane that fits the overall program aesthetics. + * A custom scroll pane that fits the overall program aesthetics. * * @author Bonino, Francisco Ignacio. * diff --git a/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomSeparator.java b/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomSeparator.java index a588ec3..f1d656a 100644 --- a/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomSeparator.java +++ b/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomSeparator.java @@ -6,9 +6,7 @@ import javax.swing.JSeparator; /** - * Custom separator class. - * - *

This class is used to instantiate a custom separator that fits the overall program aesthetics. + * A custom separator that fits the overall program aesthetics. * * @author Bonino, Francisco Ignacio. * diff --git a/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomSpinner.java b/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomSpinner.java index 45b5cc5..dec6574 100644 --- a/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomSpinner.java +++ b/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomSpinner.java @@ -14,9 +14,7 @@ import javax.swing.text.DefaultCaret; /** - * Custom spinner class. - * - *

This class is used to instantiate a custom spinner that fits the overall program aesthetics. + * A custom spinner that fits the overall program aesthetics. * * @author Bonino, Francisco Ignacio. * diff --git a/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomTable.java b/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomTable.java index 39bacd4..182e07c 100644 --- a/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomTable.java +++ b/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomTable.java @@ -12,9 +12,7 @@ import javax.swing.table.DefaultTableCellRenderer; /** - * Custom table class. - * - *

This class is used to instantiate a custom table that fits the overall program aesthetics. + * A custom table that fits the overall program aesthetics. * * @author Bonino, Francisco Ignacio. * diff --git a/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomTextArea.java b/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomTextArea.java index f054ba7..220f0f3 100644 --- a/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomTextArea.java +++ b/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomTextArea.java @@ -5,10 +5,7 @@ import javax.swing.JTextArea; /** - * Custom text area class. - * - *

This class is used to instantiate a custom text area that fits the overall program aesthetics. It is supposed to be used along with a custom - * scroll pane to ensure its correct display. + * A custom text area that fits the overall program aesthetics. It must be used along with a custom scroll pane to ensure it is correctly displayed. * * @author Bonino, Francisco Ignacio. * diff --git a/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomTextField.java b/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomTextField.java index b216153..ce9a1db 100644 --- a/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomTextField.java +++ b/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomTextField.java @@ -7,9 +7,7 @@ import javax.swing.JTextField; /** - * Custom text field class. - * - *

This class is used to instantiate a custom text field that fits the overall program aesthetics. + * A custom text field that fits the overall program aesthetics. * * @author Bonino, Francisco Ignacio. * diff --git a/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomToolTip.java b/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomToolTip.java index eac966e..cd46fd5 100644 --- a/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomToolTip.java +++ b/src/main/java/armameeldoparti/utils/common/custom/graphical/CustomToolTip.java @@ -19,9 +19,7 @@ import javax.swing.plaf.ToolTipUI; /** - * Custom tooltip class. - * - *

This class is used to instantiate a custom tooltip that fits the overall program aesthetics. + * A custom tooltip that fits the overall program aesthetics. * * @author Bonino, Francisco Ignacio. *