Basically, the purpose of this post is as a follow-on from this post where the decision was made to stop recommending the @should
taglet, but to maintain it’s presence in Javadoc. I would like to propose removing the taglet altogether from OpenMRS’s source code.
Rationale
- It has not been the recommended way to create tests for years.
- It is not clear that the IDE plugins required to make this annotation helpful have been maintained.
- The Taglet API has undergone a major revision, following the sun-setting of the internal
com.sun.*
classes that it used to depend on, meaning we’d have to somehow maintain the current state of the taglet API and create a version for Java 9 or later.
Way forward
I’d propose we take the following steps:
- Remove the
ShouldTaglet
class from openmrs-tools - Replace all occurrences of the
@should
taglet in OpenMRS Javadoc with<strong>Should</strong>
, allowing us to keep the data provided by this taglet in a human-readable format.
Are there any objections to this or thoughts on a better way forward, etc.?