Skip to content

Commit

Permalink
Refactored campaign option tabs to use unordered lists.
Browse files Browse the repository at this point in the history
Replaced HTML paragraph tags with unordered list tags across various campaign option tabs for improved semantic structure and readability. This enhances consistency and better aligns with modern UI documentation standards.
  • Loading branch information
IllianiCBT committed Jan 14, 2025
1 parent 8171fd5 commit 99e2c90
Show file tree
Hide file tree
Showing 13 changed files with 38 additions and 33 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:
* <p>
* <ul>
* <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>
* </p>
* </ul>
*/
public enum AbilityCategory {
COMBAT_ABILITY, MANEUVERING_ABILITY, UTILITY_ABILITY
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,13 +45,13 @@
* It facilitates user interaction for fine-tuning the game campaign experience.
* </p>
*
* <h3>Key Features:</h3>
* <p>
* <strong>Key Features:</strong>
* <ul>
* <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>
* </p>
* </ul>
*/
public class CampaignOptionsDialog extends AbstractMHQButtonDialog {
private static final String RESOURCE_PACKAGE = "mekhq/resources/CampaignOptionsDialog";
Expand Down
6 changes: 3 additions & 3 deletions MekHQ/src/mekhq/gui/campaignOptions/CampaignOptionsPane.java
Original file line number Diff line number Diff line change
Expand Up @@ -55,14 +55,14 @@
* and {@code STARTUP}, to determine the level of detail and features shown.
* </p>
*
* <h3>Key Features:</h3>
* <p>
* <strong>Key Features:</strong>
* <ul>
* <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>
* </p>
* </ul>
*/
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 @@ -41,15 +41,15 @@
* making its methods accessible in a static fashion.
* </p>
*
* <h3>Key Features:</h3>
* <p>
* <strong>Key Features:</strong>
* <ul>
* <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>
* </p>
* </ul>
*/
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 @@ -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:
* <p>
* <ul>
* <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>
* </p>
* </ul>
*
* 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
4 changes: 2 additions & 2 deletions MekHQ/src/mekhq/gui/campaignOptions/contents/GeneralTab.java
Original file line number Diff line number Diff line change
Expand Up @@ -53,13 +53,13 @@
/**
* Represents a tab within the campaign options UI that allows the user to configure
* general campaign settings. This includes options for:
* <p>
* <ul>
* <li>Configuring the campaign name</li>
* <li>Setting the faction and faction-related options</li>
* <li>Adjusting reputation and manual unit rating modifiers</li>
* <li>Specifying the campaign start date</li>
* <li>Choosing a camouflage pattern and unit icon</li>
* </p>
* </ul>
*
* This class extends the user interface features provided by {@link AbstractMHQTabbedPane}.
*/
Expand Down
4 changes: 2 additions & 2 deletions MekHQ/src/mekhq/gui/campaignOptions/contents/MarketsTab.java
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,12 @@
/**
* The {@code MarketsTab} class represents the campaign options tab related to market settings.
* This tab provides configurations for three key market areas:
* <p>
* <ul>
* <li><b>Personnel Market</b>: Settings for managing personnel hiring, removal targets, and market types.</li>
* <li><b>Unit Market</b>: Configurations for purchasing units, special unit chances, rarity modifiers, etc.</li>
* <li><b>Contract Market</b>: Options for contract acquisition, such as market methods, search radius,
* and payment settings.</li>
* </p>
* </ul>
* <p>
* The class initializes the UI components for these three market types and provides methods to
* load data into the UI or apply changes from the UI to the campaign settings.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,8 @@
* logs, information, awards, medical options, salaries, and prisoners and dependents.
* <p>
* The class is organized into multiple tabs that encapsulate settings under specific categories:
* <p>
* </p>
* <ul>
* <li><b>General Tab:</b> General settings for personnel management such as tactics,
* initiative bonus, toughness, and edge settings.</li>
* <li><b>Personnel Logs Tab:</b> Settings for logging activities like skill or ability
Expand All @@ -67,7 +68,7 @@
* and dependent-related rules.</li>
* <li><b>Salaries Tab:</b> Configuration of salaries based on roles, experience
* multipliers, and base salary rates.</li>
* </p>
* </ul>
*
* <p>
* This class serves as the main controller for the UI components of the Personnel Tab,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,11 @@
* <p>
* The tab is divided into three main sections:
* </p>
* <p>
* <ul>
* <li>Marriage Tab: Manages configurations for manual and random marriage settings.</li>
* <li>Divorce Tab: Manages configurations for manual and random divorce settings.</li>
* <li>Procreation Tab: Manages configurations for manual and random procreation settings.</li>
* </p>
* </ul>
*/
public class RelationshipsTab {
private final CampaignOptions campaignOptions;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,12 @@
* <p>
* This tab is divided into two sections:
* </p>
* <p>
* <ul>
* <li><b>Repair Tab:</b> Manages options for era modifications, tech assignments,
* equipment quirks handling, destruction margins, and more.</li>
* <li><b>Maintenance Tab:</b> Handles maintenance settings such as cycle frequency, quality standards,
* planetary modifiers, and unofficial maintenance rules.</li>
* </p>
* </ul>
* <p>
* The class interacts with {@link CampaignOptions}, enabling the retrieval, storage,
* and application of repair and maintenance configuration settings.
Expand Down
6 changes: 3 additions & 3 deletions MekHQ/src/mekhq/gui/campaignOptions/contents/RulesetsTab.java
Original file line number Diff line number Diff line change
Expand Up @@ -45,15 +45,15 @@
* opponent force generation, scenario rules, equipment behavior, and campaign-specific variations.
* </p>
*
* <h3>Tab Sections:</h3>
* <p>
* <strong>Tab Sections:</strong>
* <ul>
* <li><b>Universal Options:</b> Handles features applicable to all campaigns,
* such as skill levels, unit ratios, map conditions, and auto-resolve settings.</li>
* <li><b>Legacy AtB:</b> Legacy-specific rules for opponent force generation,
* scenario generation probabilities, and battle intensity configurations.</li>
* <li><b>StratCon:</b> Settings for Strategic Context campaigns, including BV usage
* (Battle Values) and verbose bidding options.</li>
* </p>
* </ul>
*/
public class RulesetsTab {
private static final String RESOURCE_PACKAGE = "mekhq/resources/CampaignOptionsDialog";
Expand Down
6 changes: 4 additions & 2 deletions MekHQ/src/mekhq/gui/campaignOptions/contents/SkillsTab.java
Original file line number Diff line number Diff line change
Expand Up @@ -40,12 +40,14 @@
* to configure the rules and costs associated with skills in their campaign.
* <p>
* This tab can be configured for either combat or support skills. It allows users to:
* <p>
* </p>
* <ul>
* <li>Set skill target numbers.</li>
* <li>Specify skill costs at different levels.</li>
* <li>Define milestones for the progression of skills by skill levels.</li>
* <li>Copy and paste configurations for skill settings.</li>
* </p>
* </ul>
* <p>
* The interface is dynamically created to display all relevant skill options for the
* selected tab (combat or support).
* </p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,19 +35,21 @@
* configuration tab in the campaign options for managing unit turnover, retention, and fatigue settings.
* <p>
* This class provides functionality to define and customize gameplay-related options such as:
* <p>
* </p>
* <ul>
* <li>Unit turnover settings, including retirement, contract durations, payouts, and modifiers.</li>
* <li>Administrative strain and management skills impacting unit cohesion.</li>
* <li>Fatigue mechanics such as fatigue rates, leave thresholds, and injury fatigue.</li>
* </p>
* </p>
* </ul>
* <p>
* The class interacts with a {@link CampaignOptions} object, allowing the user to load and save
* configurations. It consists of two main panels:
* <p>
* </p>
* <ul>
* <li><strong>Turnover Tab:</strong> Controls unit turnover, payouts, and related modifiers.</li>
* <li><strong>Fatigue Tab:</strong> Manages fatigue-related options like kitchen capacity
* and fatigue rates.</li>
* </p>
* </ul>
*/
public class TurnoverAndRetentionTab {
private final CampaignOptions campaignOptions;
Expand Down

0 comments on commit 99e2c90

Please sign in to comment.