Junit4: more javadocs would be helpful

[Reissner]

I use JUnit for a while.
I also wrote a graphical wrapper for it, because i do not use the usual ide but emacs with jdee.
For people like me, more detailed javadocs would be helpful.

[marcphilipp]

On which classes did you miss more detailed Javadoc?

[Reissner]

Hi Marc,
the most basic ones.
E.g. Description is almost not at all described. equals and hashcode are
vital. testcount counts the atomic tests only and so on.
Failure: convenience methods are based on exception, docs would be helpful.
Result is quite subtile: is used in conjunction with
RunListener.testRunFinished.

Required is what goes into getIgnoreCount() (assumptions false?), what
goes into getRunCount (ignores no, assumptions false yes) and so on.
Also igores go into getFailureCount()

Taking all together, it is quite tricky:
In my opinion, getAssumptionsFailed() is missing.

Also RunListener: which methods are invoked by RunNotifier in which
ordering: not clear enough. I just found out
but docs would be better for sake of stability: I can never know whether
my observations are true by accident.

There is a lot like this.

I would like to suggest additional docs in close cooperation with an
experienced junit-developer.

Best Regards,

Ernst

On which classes did you miss more detailed Javadoc?

—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
https://github.com/junit-team/junit4/issues/1314#issuecomment-222671617,
or mute the thread
https://github.com/notifications/unsubscribe/AE0OIH1cXhDsnIDPhZfEPY-jk_OuHgRrks5qHCc2gaJpZM4IqdMd.

[PeterWippermann]

@Reissner Why don't you start a pull request and add the JavaDocs for a single class with the documentation you would have liked to see? Let's see, how this works :-)