sageserpent-open / americium

Generation of test case data for Scala and Java, in the spirit of QuickCheck. When your test fails, it gives you a minimised failing test case and a way of reproducing the failure immediately.
MIT License
15 stars 1 forks source link

Redeem incomprehensible client-facing interfaces. #4

Closed sageserpent-open closed 3 years ago

sageserpent-open commented 3 years ago

Using the TrialsApi from a Java project within IntelliJ reveals some minimal Javadoc - but the Java form of Trials is devoid of any documentation, as it is decompiled in IntelliJ from a JAR built with Scala source for that trait.

There is some Scaladoc in the Scala sources, but it is lost in translation.

What's more, looking back at the original sources, some interface/trait/class-level Javadoc would be helpful.

Perhaps more of the Java-facing code should be written in straight Java too?

Anyway, the goal is to provide the end-user who has just pulled in Maven or Gradle dependency into their Java project a more wholesome experience when they explore the API via the IDE tooltips / code-completion / pop-up documentation / plain old source browsing.