Skip to content

Commit

Permalink
Refactored list markup in JavaDoc comments to improve clarity.
Browse files Browse the repository at this point in the history
Converted unordered `<ul>` HTML tags to `<p>` for consistency and better formatting in JavaDoc comments. This change enhances readability and simplifies the markup structure across various campaign option classes and tab components.
  • Loading branch information
IllianiCBT committed Jan 14, 2025
1 parent f1bb5cf commit 9b16c80
Show file tree
Hide file tree
Showing 13 changed files with 84 additions and 84 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,11 @@ public class CampaignOptionsAbilityInfo {
/**
* Enum {@code AbilityCategory} represents the categories abilities can belong to.
* Categories available:
* <ul>
* <p>
* <li>{@code COMBAT_ABILITIES}: Abilities related to combat actions</li>
* <li>{@code MANEUVERING_ABILITIES}: Abilities related to movement and maneuvering</li>
* <li>{@code UTILITY_ABILITIES}: Abilities providing utility or non-combat benefits</li>
* </ul>
* </p>
*/
public enum AbilityCategory {
COMBAT_ABILITY, MANEUVERING_ABILITY, UTILITY_ABILITY
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,12 +46,12 @@
* </p>
*
* <h3>Key Features:</h3>
* <ul>
* <p>
* <li>Initialization in multiple modes, such as NORMAL, STARTUP, and ABRIDGED.</li>
* <li>Ability to load and save presets for recurring configurations.</li>
* <li>Application of campaign settings directly to the active {@link Campaign} instance.</li>
* <li>Visual notifications, such as a notice about StratCon activation during the campaign.</li>
* </ul>
* </p>
*/
public class CampaignOptionsDialog extends AbstractMHQButtonDialog {
private static final String RESOURCE_PACKAGE = "mekhq/resources/CampaignOptionsDialog";
Expand Down
4 changes: 2 additions & 2 deletions MekHQ/src/mekhq/gui/campaignOptions/CampaignOptionsPane.java
Original file line number Diff line number Diff line change
Expand Up @@ -56,13 +56,13 @@
* </p>
*
* <h3>Key Features:</h3>
* <ul>
* <p>
* <li>Organizes options into logical groups, such as General, Human Resources,
* Advancement, Logistics, and Operations.</li>
* <li>Supports loading and applying campaign presets for streamlined configuration.</li>
* <li>Dynamically handles UI scaling and scrolling speed based on environment properties.</li>
* <li>Allows scalability for future addition of new campaign settings.</li>
* </ul>
* </p>
*/
public class CampaignOptionsPane extends AbstractMHQTabbedPane {
private static final String RESOURCE_PACKAGE = "mekhq/resources/CampaignOptionsDialog";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,14 +42,14 @@
* </p>
*
* <h3>Key Features:</h3>
* <ul>
* <p>
* <li>Provides reusable methods to create and configure {@link JPanel} objects.</li>
* <li>Handles creation of organized, alphabetized tab groups with specialized handling for
* "general options" tabs.</li>
* <li>Offers UI utility methods for processing resource names, image directories,
* and dynamic content scaling.</li>
* <li>Supports internationalization through the {@link ResourceBundle} for localized strings.</li>
* </ul>
* </p>
*/
public class CampaignOptionsUtilities {
private static final String RESOURCE_PACKAGE = "mekhq/resources/CampaignOptionsDialog";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,11 @@ public class CampaignOptionsGridBagConstraints extends GridBagConstraints {
* <p>
* The {@code JPanel} will automatically be set to use a {@link GridBagLayout}.
* Default constraints include:
* <ul>
* <p>
* <li>{@code anchor} set to {@link GridBagConstraints#NORTHWEST}</li>
* <li>{@code fill} set to {@link GridBagConstraints#BOTH}</li>
* <li>{@code insets} set to {@code new Insets(5, 5, 5, 5)}</li>
* </ul>
* </p>
*
* @param panel the {@link JPanel} for which the {@link GridBagConstraints} is created
*/
Expand All @@ -61,10 +61,10 @@ public CampaignOptionsGridBagConstraints(JPanel panel) {
* The {@code JPanel} will automatically be set to use a {@link GridBagLayout}.
* If {@code anchor} or {@code fill} values are not provided, the following default
* values are used:
* <ul>
* <p>
* <li>Default {@code anchor}: {@link GridBagConstraints#NORTHWEST}</li>
* <li>Default {@code fill}: {@link GridBagConstraints#BOTH}</li>
* </ul>
* </p>
* Default {@code insets} are set to {@code new Insets(5, 5, 5, 5)}.
*
* @param panel the {@link JPanel} for which the {@link GridBagConstraints} is created
Expand Down
84 changes: 42 additions & 42 deletions MekHQ/src/mekhq/gui/campaignOptions/contents/BiographyTab.java
Original file line number Diff line number Diff line change
Expand Up @@ -48,14 +48,14 @@
/**
* The `BiographyTab` class is responsible for managing the biography-related settings in the campaign options tab
* within the MekHQ application. It provides an interface for configuring various campaign settings, such as:
* <ul>
* <p>
* <li>General campaign settings like gender distribution and familial relationships.</li>
* <li>Background options, including randomized personality traits and origin determination.</li>
* <li>Death-related settings such as probability of random deaths, age-group-specific deaths, etc.</li>
* <li>Education module settings for academic progression, dropout chances, and related configurations.</li>
* <li>Random name generation and portrait assignment based on roles and factions.</li>
* <li>Rank and hierarchy management for campaign personnel.</li>
* </ul>
* </p>
*
* The class includes methods to initialize, load, and configure settings while providing GUI tools to enable user
* interaction. It also integrates with the current `Campaign` and `CampaignOptions` objects to synchronize settings.
Expand Down Expand Up @@ -188,15 +188,15 @@ public BiographyTab(Campaign campaign) {
/**
* Initializes the various sections and settings tabs within the BiographyTab.
* This method organizes the following tabs:
* <ul>
* <p>
* <li>General Tab: Handles general campaign settings such as gender distribution and
* relationship displays.</li>
* <li>Background Tab: Configures randomized backgrounds for campaign characters.</li>
* <li>Death Tab: Sets up random death rules and options.</li>
* <li>Education Tab: Defines education-related gameplay settings.</li>
* <li>Name and Portrait Tab: Configures rules for name and portrait generation.</li>
* <li>Rank Tab: Manages the rank systems for campaign personnel.</li>
* </ul>
* </p>
*/
private void initialize() {
initializeGeneralTab();
Expand All @@ -210,11 +210,11 @@ private void initialize() {

/**
* Initializes the Name and Portrait tab. The tab allows users to:
* <ul>
* <p>
* <li>Enable or disable the use of origin factions for name generation.</li>
* <li>Assign portraits to personnel upon role changes.</li>
* <li>Customize which portraits should be used randomly based on roles.</li>
* </ul>
* </p>
*/
private void initializeNameAndPortraitTab() {
chkUseOriginFactionForNames = new JCheckBox();
Expand All @@ -230,12 +230,12 @@ private void initializeNameAndPortraitTab() {

/**
* Initializes the Education tab, providing settings such as:
* <ul>
* <p>
* <li>Setting curriculum XP rates.</li>
* <li>Enabling re-education camps or specific academy requirements.</li>
* <li>Managing academy dropout chances for adults and children.</li>
* <li>Supporting the configuration of education-related accidents and events.</li>
* </ul>
* </p>
*/
private void initializeEducationTab() {
chkUseEducationModule = new JCheckBox();
Expand Down Expand Up @@ -273,11 +273,11 @@ private void initializeEducationTab() {

/**
* Initializes the Death tab, focusing on:
* <ul>
* <p>
* <li>Allowing configuration of random death probabilities for personnel.</li>
* <li>Customizing age-group-specific death settings.</li>
* <li>Selecting methods for random deaths (e.g., natural causes or accidents).</li>
* </ul>
* </p>
*/
private void initializeDeathTab() {
chkKeepMarriedNameUponSpouseDeath = new JCheckBox();
Expand All @@ -295,11 +295,11 @@ private void initializeDeathTab() {

/**
* Initializes the Backgrounds tab, which handles:
* <ul>
* <p>
* <li>Randomized background settings for characters.</li>
* <li>Options for specifying origins (e.g., faction-specific planetary systems).</li>
* <li>Custom search radius and distance scaling for randomized origins.</li>
* </ul>
* </p>
*/
private void initializeBackgroundsTab() {
pnlRandomBackgrounds = new JPanel();
Expand Down Expand Up @@ -327,11 +327,11 @@ private void initializeBackgroundsTab() {

/**
* Initializes the General tab, which provides options for:
* <ul>
* <p>
* <li>General gameplay settings such as gender distribution sliders.</li>
* <li>Configuration of familial display levels and other general campaign settings.</li>
* <li>Annunciation of anniversaries, recruitment dates, and officer-related milestones.</li>
* </ul>
* </p>
*/
private void initializeGeneralTab() {
chkUseDylansRandomXP = new JCheckBox();
Expand Down Expand Up @@ -365,11 +365,11 @@ private static DefaultComboBoxModel<String> getFactionNamesModel() {

/**
* Creates and lays out the General tab, including its components like:
* <ul>
* <p>
* <li>Checkboxes for random XP distribution.</li>
* <li>Sliders for gender representation customization.</li>
* <li>Combo boxes for family display level settings within the GUI.</li>
* </ul>
* </p>
*
* @return A `JPanel` representing the General tab in the campaign options dialog.
*/
Expand Down Expand Up @@ -441,10 +441,10 @@ public JPanel createGeneralTab() {

/**
* Creates the Anniversaries panel within the General tab for managing announcement-related settings:
* <ul>
* <p>
* <li>Enabling birthday and recruitment anniversary announcements.</li>
* <li>Specifying whether such announcements should be limited to officers.</li>
* </ul>
* </p>
*
* @return A `JPanel` containing the UI components for defining anniversary-related settings.
*/
Expand Down Expand Up @@ -480,10 +480,10 @@ private JPanel createAnniversariesPanel() {

/**
* Creates and lays out the Backgrounds tab, which includes:
* <ul>
* <p>
* <li>Settings for enabling randomized personalities and relationships.</li>
* <li>Random origin configurations such as faction specificity and distance scaling.</li>
* </ul>
* </p>
*
* @return A `JPanel` representing the Backgrounds tab in the campaign options dialog.
*/
Expand Down Expand Up @@ -520,12 +520,12 @@ public JPanel createBackgroundsTab() {
* Creates the panel for configuring random background options in the campaign.
* <p>
* This includes controls to enable or disable features such as:
* <ul>
* <p>
* <li>Random personalities for characters.</li>
* <li>Random personality reputation.</li>
* <li>Intelligence XP multipliers.</li>
* <li>Simulated relationships.</li>
* </ul>
* </p>
*
* @return A {@code JPanel} representing the random background configuration UI.
*/
Expand Down Expand Up @@ -560,11 +560,11 @@ JPanel createRandomBackgroundsPanel() {

/**
* Creates and returns a panel for random origin options. This includes:
* <ul>
* <p>
* <li>Controls to enable or disable randomization of origins.</li>
* <li>Options for selecting specific planetary systems or factions for origin determination.</li>
* <li>Search radius and distance scaling fields to tweak origin calculations.</li>
* </ul>
* </p>
*
* @return A `JPanel` for managing random origin settings.
*/
Expand Down Expand Up @@ -741,11 +741,11 @@ private PlanetarySystem[] getPlanetarySystems(final @Nullable Faction faction) {

/**
* Configures and creates the Death tab. This includes options like:
* <ul>
* <p>
* <li>Methods for random death.</li>
* <li>Percentage-based chances for random death events.</li>
* <li>Check boxes to enable or disable age-specific death events.</li>
* </ul>
* </p>
*
* @return A `JPanel` representing the Death tab.
*/
Expand Down Expand Up @@ -863,12 +863,12 @@ private JPanel createDeathAgeGroupsPanel() {
* Creates the Education tab, which allows managing educational settings within the campaign.
* <p>
* This includes:
* <ul>
* <p>
* <li>Setting curriculum XP rates.</li>
* <li>Configuring academy requirements and override options.</li>
* <li>Managing dropout chances for adults and children.</li>
* <li>Enabling or disabling the use of reeducation camps, accidents, and events.</li>
* </ul>
* </p>
*
* @return A {@code JPanel} representing the Education tab in the campaign UI.
*/
Expand Down Expand Up @@ -987,11 +987,11 @@ public JPanel createEducationTab() {
* Creates a panel for enabling different education-related academy sets.
* <p>
* This includes options to toggle various academy types:
* <ul>
* <p>
* <li>Local academies.</li>
* <li>Prestigious academies.</li>
* <li>Unit-based education academies.</li>
* </ul>
* </p>
*
* @return A {@code JPanel} containing the Enable Standard Sets UI components.
*/
Expand Down Expand Up @@ -1023,10 +1023,10 @@ private JPanel createEnableStandardSetsPanel() {
* Creates a panel for configuring experience gain and skill bonuses.
* <p>
* This includes:
* <ul>
* <p>
* <li>Option to enable or disable bonuses.</li>
* <li>Setting the faculty XP multiplier.</li>
* </ul>
* </p>
*
* @return A {@code JPanel} for managing XP rates and skill bonuses.
*/
Expand Down Expand Up @@ -1060,10 +1060,10 @@ private JPanel createXpAndSkillBonusesPanel() {
* Creates a panel for configuring dropout chances for academies.
* <p>
* This includes:
* <ul>
* <p>
* <li>Setting the dropout chance for adults.</li>
* <li>Setting the dropout chance for children.</li>
* </ul>
* </p>
*
* @return A {@code JPanel} for managing dropout chance settings.
*/
Expand Down Expand Up @@ -1101,10 +1101,10 @@ private JPanel createDropoutChancePanel() {
* Creates a panel for configuring accidents and events related to military academies.
* <p>
* This includes:
* <ul>
* <p>
* <li>Toggling settings for all-age accidents.</li>
* <li>Configuring the frequency of military academy accidents.</li>
* </ul>
* </p>
*
* @return A {@code JPanel} containing the accidents and events configuration UI.
*/
Expand Down Expand Up @@ -1136,11 +1136,11 @@ private JPanel createAccidentsAndEventsPanel() {
* Creates the Name and Portrait Generation tab for the campaign options.
* <p>
* This tab allows users to:
* <ul>
* <p>
* <li>Enable or disable the use of origin factions for name generation.</li>
* <li>Assign portraits to personnel upon role changes.</li>
* <li>Customize which portraits are randomly used for specific roles.</li>
* </ul>
* </p>
*
* @return A {@code JPanel} representing the Name and Portrait Generation tab.
*/
Expand Down Expand Up @@ -1200,10 +1200,10 @@ public JPanel createNameAndPortraitGenerationTab() {
* Creates a panel for customizing random portrait generation for personnel roles.
* <p>
* This includes:
* <ul>
* <p>
* <li>Options to enable or disable the use of role-specific portraits.</li>
* <li>Buttons to toggle all or no portrait options collectively.</li>
* </ul>
* </p>
*
* @return A {@code JPanel} containing the random portrait generation configuration UI.
*/
Expand Down Expand Up @@ -1266,10 +1266,10 @@ private JPanel createRandomPortraitPanel() {
* Creates the Rank tab for configuring rank systems within the campaign.
* <p>
* This tab provides options for:
* <ul>
* <p>
* <li>Managing rank systems for personnel in the campaign.</li>
* <li>Displaying rank-related UI components for user configuration.</li>
* </ul>
* </p>
*
* @return A {@code JPanel} representing the Rank tab in the campaign configuration.
*/
Expand Down
Loading

0 comments on commit 9b16c80

Please sign in to comment.