Skip to content

Build & Docs: Quality and Maintenance Enhancements#164

Merged
hajk1 merged 5 commits intoarturmkrtchyan:masterfrom
spannm:feature/maven-updates
Jul 28, 2025
Merged

Build & Docs: Quality and Maintenance Enhancements#164
hajk1 merged 5 commits intoarturmkrtchyan:masterfrom
spannm:feature/maven-updates

Conversation

@spannm
Copy link
Contributor

@spannm spannm commented Jul 27, 2025

  • Streamlined Build: Centralized all Maven plugin and dependency versions in pom.xml properties for easier management and applied key plugin updates for better stability and security.

  • Updated plugins and dependencies to latest releases.

  • Standardized POM: Integrated Sortpom plugin to ensure consistent pom.xml formatting.

  • Enhanced Javadoc: Added extensive Javadoc throughout the codebase, successfully resolving all Javadoc warnings and improving API documentation overall.

These changes make the build more robust and the codebase easier to understand and maintain.

spannm added 5 commits July 27, 2025 14:23
Extracted all hardcoded plugin and dependency versions into properties
within 'pom.xml' for improved maintainability and easier updates.
Also added 'junit-bom' to 'dependencyManagement'.
Updated several Maven plugin versions and test dependency versions to
their latest stable releases. This includes updates for:
- Maven Compiler Plugin
- Maven Surefire Plugin
- JaCoCo Plugin
- Maven Source Plugin
- Maven Javadoc Plugin
- Maven GPG Plugin
- Maven Release Plugin
- Nexus Staging Maven Plugin
- JUnit Jupiter BOM
- Hamcrest
- FindBugs Plugin
- JDepend Plugin
Introduced the Sortpom Maven Plugin to standardize POM formatting,
ensuring consistent indentation, line endings, and element ordering.
Apply reformattings from Sortpom Maven Plugin.
Enhanced and added Javadoc documentation for
classes, enums, fields, constructors, and public methods:

- Improved class-level descriptions for clarity.
- Detailed Javadoc for getters, factory methods, and constructors.
- One-line Javadoc for 'CountryCode' enum constants.
- Added a private constructor to 'BicUtil' to prevent instantiation.
@hajk1 hajk1 merged commit cc3bb39 into arturmkrtchyan:master Jul 28, 2025
1 check passed
@spannm spannm deleted the feature/maven-updates branch July 29, 2025 05:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants