Hemanth7723 opened a new pull request, #185:
URL: https://github.com/apache/fineract-loan-origination/pull/185

   ## Description
   
   Standardizes Java comments and Javadoc documentation across backend modules 
as part of #99.
   
   ### Problem
   The existing backend codebase contained inconsistent comment formatting, 
redundant HTML tags (`<p>`, `<ul>`, `<li>`, `<ol>`, `<h2>`, `<strong>`, 
`<pre>`), verbose multi-sentence field comments that duplicated self-evident 
variable names, and repetitive inline comments directly restating the code 
below them.
   
   ### Solution
   - Cleaned up and standardized Javadocs across 18 backend files to adopt the 
concise, plain-prose convention established across the Apache Fineract 
repository.
   - Removed obsolete HTML formatting tags in favor of clean plain-text/Javadoc 
formatting where appropriate.
   - Stripped redundant inline comments that mirrored adjacent code statements.
   - **Zero functional impact:** No business logic, method signatures, API 
contracts, database schemas, or test behaviors were modified.
   
   Closes #99
   
   ## Verification
   
   - [x] `./mvnw spotless:apply` (Applied code style formatting rules)
   - [x] `./mvnw clean verify` (Build passed; all existing unit and integration 
tests passed)
   - [x] `./mvnw apache-rat:check` (Passed; license headers validated)
   - [x] Frontend changes: Not applicable (Backend documentation and comment 
cleanup only)
   
   ## AI assistance (optional)
   
   - Tool / model: None
   - How it was used: Not applicable
   
   ## Checklist
   
   - [x] This PR is one logical change, not a code dump.
   - [x] I added or updated tests, or explained why tests are not needed (Tests 
not needed: non-functional doc/comment refactor only).
   - [x] New files carry the ASF license header (No new files added).
   - [x] Docs (and `AGENTS.md`, if commands, paths, or architecture rules 
changed) are updated (Not applicable).
   - [x] All commits are signed.
   - [x] I followed the [AI 
Policy](https://github.com/apache/fineract/blob/develop/CONTRIBUTING.md#ai-policy)
 and the [ASF Generative Tooling 
Guidance](https://www.apache.org/legal/generative-tooling.html).


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to