[OPENNLP-1419] Enhance Tests and JavaDoc in opennlp.morfologik package

• Type: Improvement
• Status: Closed
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 2.1.0
• Fix Version/s: 2.1.1
• Component/s: Morfologik Addon
• Assignee: Martin Wiesner
• Reporter: Martin Wiesner
• Created: 19/Dec/22 21:28
• Updated: 28/Jan/23 15:00
• Resolved: 22/Dec/22 09:45

Description

The (JUnit) tests in opennlp.morfologik package show an anti-pattern of test classes relying on each other, that is: code is mixed around and feels near to spaghetti. Moreover, the naming of some of the existing test classes is not consistent with the classes under test. This should both be fixed and improved.

The JavaDoc the opennlp.morfologik package shows several inconsistencies and missing descriptions. Moreover, several typos are present that need sanitizing, especially in class names.

Both aspects need a cure and the package some additions to provide more clarity for readers of the API and devs with respect to understanding the test setup correctly.