search

AxonFramework / AxonFramework

Framework for Evolutionary Message-Driven Microservices on the JVM
https://axoniq.io/
Apache License 2.0
3.32k stars 790 forks source link

[#2966] Add and enhance JavaDoc for the new Unit of Work #3110

Closed smcvb closed 2 months ago

smcvb commented 2 months ago

This pull request serves as an addition to #2953. We merged #2953 as it was a very important milestone, mandatory to proceed with working on other infrastructure components. However, as the Unit of Work rewrite and introduction of the ProcessingLifecycle and ProcessingContext are extremely central to Axon Framework, I deemed an early revamp of the JavaDoc and API changes documentation to be paramount for further development.

Hence, that is exactly what this pull request does. It adds JavaDoc, adjusts JavaDoc, renames parameters, reorders variables and methods, and further cleans up any irregularities to provide a strong basis for proceeding with Axon Framework 5's development.

Added, as the UnitOfWork, and the other deprecated and soon-to-be-removed implementations of this UnitOfWork, are part of the public API, I have drafted an explanation in the api-changes.md file. This file will guide us during the construction of a migration guide and help users who prefer to jump on the bandwagon quickly.

By doing the above, this PR resolves #2966.

sonarcloud[bot] commented 2 months ago

Quality Gate Failed Quality Gate failed

Failed conditions
60.6% Coverage on New Code (required ≥ 80%)
E Reliability Rating on New Code (required ≥ A)

See analysis details on SonarCloud

Catch issues before they fail your Quality Gate with our IDE extension SonarLint