On Jul 20, 2009, at 10:37 AM, Russel Winder wrote:
On Mon, 2009-07-20 at 09:37 +0200, Hans Dockter wrote:
On Jul 19, 2009, at 10:36 AM, Russel Winder wrote:
The main comment on this class says:
"A task for executing JUnit 3.8.x and JUnit 4 tests."
Does this imply support for TestNG is being deprecated?
It does imply that the Javadoc is a bit stale.
Actually the documentation of the source code is not good. Very few
of
the methods have proper documentation. This makes it incredibly
difficult to use the API documentation since it is just a list of
methods, their return types and parameter list. The documentation
assumes the reader knows everything.
There are some islands in the code where the documentation is not
good. Other parts of the API have excellent docs. This has also
historical reasons as the Groovydoc tool was initially pretty useless.
This has changed but not the groovydoc.
I think there needs to be a concerted effort to improve the
JavaDoc/GroovyDoc commenting so that people who don't know the API can
access it.
This may not be a 0.7 thing, but it must happen before 1.0.
I fully agree. The whole public API must be 100 percent covered with
decent API doc before 1.0.
- Hans
--
Hans Dockter
Gradle Project Manager
http://www.gradle.org
---------------------------------------------------------------------
To unsubscribe from this list, please visit:
http://xircles.codehaus.org/manage_email
