[Cdk-devel] More on CDK JavaDoc testing...

[Egon W. <ego...@gm...>]

Hi all,

i finished the first draft of new JavaDoc testing:
http://pele.farmbio.uu.se/nightly-ojdcheck/ojdcheckSummary.html

This is a start of replacing the proprietary DocCheck doclet, of which
the output is hard to browse, practically impossible to summarize on
Nightly, and does not take into account the CDK taglets (@cdk.keyword
etc).

Therefore, I started OpenJavaDocCheck (OJDCheck), a replacement for
DocCheck, which has a plugin mechanism for further JavaDoc testing.
OJDCheck itself will test for the same things as DocCheck and perhaps
more (one of my thing high on the wishlist is spell checking). On top
of that, I have implemented a first few checks for the CDK:

http://github.com/egonw/cdk/tree/81-ojdcheck/src/main/net/sf/cdk/tools/checkdoctest/

IncorrectBugNumberTagletTest
MissingGithashTagletTest
MissingModuleTagletTest

I have quite a few ideas of other tests, including a test for
@cdk.cite to match the cited key against the actual database, the
format of cdk.keyword tag content, a test that checks if all
@cdk.module content is compiled in build.xml, and checked in
javadoc.xml and pmd.xml.

There are still a number of false positives, and in particularly
detection of the first JavaDoc sentence (which acts as summary in the
JavaDoc) is not quite what I expected yet... for example, many errors
are now given if the first sentence has an internal tag... I am not
sure if that is an error (tags may not be allowed in the first
sentence), or my use of the Doclet API is incorrect...

So, until I have removed most of these problems, I will bring the
patches into review... for now, you can get the patches from this
branch (Nightly and SuperNightly are already updated in the main
repositories and work with and without the OJDCheck reports):

http://github.com/egonw/cdk/tree/81-ojdcheck

Please do let me know your thoughts on where this is going...

Egon

-- 
Post-doc @ Uppsala University
Homepage: http://egonw.github.com/
Blog: http://chem-bla-ics.blogspot.com/
PubList: http://www.citeulike.org/user/egonw/tag/papers