Skip to content

Commit

Permalink
fix documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
akmsw committed Jun 24, 2024
1 parent 5e0c7de commit 62e11df
Show file tree
Hide file tree
Showing 15 changed files with 17 additions and 44 deletions.
2 changes: 1 addition & 1 deletion src/main/java/armameeldoparti/utils/common/Constants.java
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
import javax.swing.ImageIcon;

/**
* Commonly-used and useful constants class.
* Common-use constants class.
*
* @author Bonino, Francisco Ignacio.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,7 @@
import javax.swing.plaf.basic.BasicArrowButton;

/**
* Custom arrow button class.
*
* <p>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.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,7 @@
import javax.swing.JButton;

/**
* Custom button class.
*
* <p>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.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,7 @@
import javax.swing.JCheckBox;

/**
* Custom checkbox class.
*
* <p>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.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,7 @@
import javax.swing.plaf.basic.ComboPopup;

/**
* Custom combobox class.
*
* <p>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.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,7 @@
import javax.swing.border.EmptyBorder;

/**
* Custom label class.
*
* <p>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.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*
* <p>The "java:S1190" and "java:S117" warnings are suppressed since JDK22 allows the use of unnamed variables.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,7 @@
import javax.swing.JRadioButton;

/**
* Custom radio button class.
*
* <p>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.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,7 @@
import javax.swing.plaf.basic.BasicScrollBarUI;

/**
* Custom scroll pane class.
*
* <p>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.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,7 @@
import javax.swing.JSeparator;

/**
* Custom separator class.
*
* <p>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.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,7 @@
import javax.swing.text.DefaultCaret;

/**
* Custom spinner class.
*
* <p>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.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,7 @@
import javax.swing.table.DefaultTableCellRenderer;

/**
* Custom table class.
*
* <p>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.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,7 @@
import javax.swing.JTextArea;

/**
* Custom text area class.
*
* <p>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.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,7 @@
import javax.swing.JTextField;

/**
* Custom text field class.
*
* <p>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.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,7 @@
import javax.swing.plaf.ToolTipUI;

/**
* Custom tooltip class.
*
* <p>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.
*
Expand Down

0 comments on commit 62e11df

Please sign in to comment.