docs: javadocs are now consistent with code, issue#4120

[DanielSEncora]

Prepare

• [ x] Read PR guidelines
• [ x] Read license information

---

Description

Javadoc was inconsistent with the code, and did not properly follow javadoc syntax, causing the "mvn javadoc:javadoc" command to fail build.

Target issue

#4120

closes #4120

---

Test and Document the changes

• Static code analysis has been run locally and issues have been fixed
• Relevant unit and integration tests have been added/updated
• Relevant documentation has been updated if any (i.e. user guides, installation and configuration guides, technical design docs etc)

Please check the below before submitting your PR. The PR will not be merged if there are no commits that start with docs: to indicate documentation changes or if the below checklist is not selected.

• [x ] I confirm that there is no impact on the docs due to the code changes in this PR.