Javadoc: Changed <br> usage to <p>

[kwek20]

Description

Changed all usages of <br/> and <br /> to <p></p> tags.
Added extra paragraph tags where needed.

Fixes #1432

Type of change

• Documentation Fix

How Has This Been Tested?

Ran the javadocs & checkstyle, fixed warnings

Checklist:

• My code follows the style guidelines for this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• [] I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes

[GalRogozinski]

When I do mvn javadoc:javadoc I get the following error:

[ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:3.1.0:javadoc (default-cli) on project iri: An error has occurred in Javadoc report generation:
[ERROR] Exit code: 1 - /home/galrogo/IdeaProjects/iri/src/main/java/com/iota/iri/utils/thread/BoundedScheduledExecutorService.java:280: error: unexpected end tag: </p>
[ERROR] * </p></p>
[ERROR] ^
[ERROR] /home/galrogo/IdeaProjects/iri/src/main/java/com/iota/iri/utils/thread/DedicatedScheduledExecutorService.java:58: warning: empty <p> tag
[ERROR] * <p>
[ERROR] ^
[ERROR] /home/galrogo/IdeaProjects/iri/src/main/java/com/iota/iri/utils/thread/DedicatedScheduledExecutorService.java:90: error: malformed HTML
[ERROR] *     </code
[ERROR] ^
[ERROR] /home/galrogo/IdeaProjects/iri/src/main/java/com/iota/iri/utils/thread/DedicatedScheduledExecutorService.java:81: error: end tag missing: </code>
[ERROR] *     <code>Resulting Log Output:
[ERROR] ^
[ERROR] /home/galrogo/IdeaProjects/iri/src/main/java/com/iota/iri/utils/thread/DedicatedScheduledExecutorService.java:92: error: unexpected end tag: </p>
[ERROR] * </p>
[ERROR] ^
[ERROR] /home/galrogo/IdeaProjects/iri/src/main/java/com/iota/iri/utils/Converter.java:18: error: unexpected end tag: </p>
[ERROR] * </p>
[ERROR] ^
[ERROR] /home/galrogo/IdeaProjects/iri/src/main/java/com/iota/iri/utils/datastructure/impl/CuckooFilterImpl.java:85: error: malformed HTML
[ERROR] * a load factor of <= 0.955. Finally we create the {@link CuckooFilterTable} that will hold our data.
[ERROR] ^
[ERROR] /home/galrogo/IdeaProjects/iri/src/main/java/com/iota/iri/utils/log/Logger.java:38: warning: no @return
[ERROR] Logger error(String message, Throwable cause);
[ERROR] ^
[ERROR] /home/galrogo/IdeaProjects/iri/src/main/java/com/iota/iri/utils/dag/DAGHelper.java:197: error: reference not found
[ERROR] * Works like {@link DAGHelper#traverseApprovees(Hash, Predicate, Consumer, Set)} but defaults to an empty
[ERROR] ^
[ERROR] /home/galrogo/IdeaProjects/iri/src/main/java/com/iota/iri/utils/dag/DAGHelper.java:200: error: reference not found
[ERROR] * @see DAGHelper#traverseApprovees(Hash, Predicate, Consumer, Set)
[ERROR] ^
[ERROR] /home/galrogo/IdeaProjects/iri/src/main/java/com/iota/iri/utils/dag/DAGHelper.java:208: warning - Tag @see: can't find traverseApprovees(Hash, Predicate, Consumer, Set) in com.iota.iri.utils.dag.DAGHelper
[ERROR] /home/galrogo/IdeaProjects/iri/src/main/java/com/iota/iri/utils/dag/DAGHelper.java:208: warning - Tag @link: can't find traverseApprovees(Hash, Predicate, Consumer, Set) in com.iota.iri.utils.dag.DAGHelper
[ERROR] /home/galrogo/IdeaProjects/iri/src/main/java/com/iota/iri/BundleValidator.java:48: error: unexpected end tag: </p>
[ERROR] *</p>
[ERROR] ^
[ERROR] /home/galrogo/IdeaProjects/iri/src/main/java/com/iota/iri/Iota.java:256: warning: no @throws for java.lang.Exception
[ERROR] public void shutdown() throws Exception {
[ERROR] ^
[ERROR] /home/galrogo/IdeaProjects/iri/src/main/java/com/iota/iri/Iota.java:120: warning: no @throws for com.iota.iri.service.spentaddresses.SpentAddressesException
[ERROR] public Iota(IotaConfig configuration) throws TransactionPruningException, SnapshotException, SpentAddressesException {
[ERROR] ^
[ERROR] /home/galrogo/IdeaProjects/iri/src/main/java/com/iota/iri/IRI.java:39: error: unexpected end tag: </p>
[ERROR] * </p>
[ERROR] ^
[ERROR] /home/galrogo/IdeaProjects/iri/src/main/java/com/iota/iri/TransactionValidator.java:104: warning: no description for @throws
[ERROR] * @throws InterruptedException
[ERROR] ^
[ERROR] /home/galrogo/IdeaProjects/iri/src/main/java/com/iota/iri/TransactionValidator.java:207: warning: no @param for curl
[ERROR] public TransactionViewModel validateBytes(final byte[] bytes, int minWeightMagnitude, Sponge curl) {
[ERROR] ^
[ERROR] /home/galrogo/IdeaProjects/iri/src/main/java/com/iota/iri/TransactionValidator.java:359: error: self-closing element not allowed
[ERROR] * <p/>
[ERROR] ^
[ERROR] /home/galrogo/IdeaProjects/iri/src/main/java/com/iota/iri/TransactionValidator.java:365: error: bad HTML entity
[ERROR] *     <li>Removes {@code transactionViewModel}'s parents (branch & trunk) from the node's tip list
[ERROR] ^
[ERROR] /home/galrogo/IdeaProjects/iri/src/main/java/com/iota/iri/TransactionValidator.java:370: error: bad HTML entity
[ERROR] *     <li>Requests missing direct parent (trunk & branch) transactions that are needed to solidify
[ERROR] ^
[ERROR] /home/galrogo/IdeaProjects/iri/src/main/java/com/iota/iri/service/spentaddresses/impl/SpentAddressesServiceImpl.java:64: warning: no @param for bundleValidator
[ERROR] public SpentAddressesServiceImpl init(Tangle tangle, SnapshotProvider snapshotProvider,
[ERROR] ^
[ERROR] /home/galrogo/IdeaProjects/iri/src/main/java/com/iota/iri/service/spentaddresses/impl/SpentAddressesServiceImpl.java:64: warning: no @param for config
[ERROR] public SpentAddressesServiceImpl init(Tangle tangle, SnapshotProvider snapshotProvider,
[ERROR] ^
[ERROR] /home/galrogo/IdeaProjects/iri/src/main/java/com/iota/iri/service/spentaddresses/SpentAddressesService.java:20: warning: no description for @throws
[ERROR] * @throws SpentAddressesException
[ERROR] ^
...

The real one is much longer.
We see that if we put certain tags inside the <p> we still get errors like:
error: unexpected end tag: </p>

So @kwek20, how did you check that the javadocs work?

@jakubcech
I want to remind that generating javadocs is not a big priority atm and not sure if we should spend more time on this atm.

Since we did get remove all those <br> removed we can merge this though after I see you both responded and are aware of the situation.

[kwek20]

@GalRogozinski i did run it! What Java are you running on?
Ill get on fixing those messages, thats all it showed?