From: Rajarshi G. <raj...@gm...> - 2009-10-22 02:11:29
|
On Oct 21, 2009, at 3:56 PM, Egon Willighagen wrote: > 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). Looks very nice > 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 What is the format of a cdk.keyword tag? Just a single word? > , a test that checks if all > @cdk.module content is compiled in build.xml, and checked in > javadoc.xml and pmd.xml. Good ideas. It'd be useful to put up a list of such tasks somewhere (feature requests, maybe?). > 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 I have added a class to ojdcheck (my own fork of your master) - how does one run it to see if it works? Also running ant -f javadoc.xml in the 81-ojdcheck branch gives me [javadoc] Constructing Javadoc information... [javadoc] javadoc: error - Error - Exception java.lang.ClassNotFoundException thrown while trying to register Taglet net.sf.cdk.tools.doclets.CDKCiteTaglet... [javadoc] javadoc: error - Error - Exception java.lang.ClassNotFoundException thrown while trying to register Taglet net.sf.cdk.tools.doclets.CDKModuleTaglet... [javadoc] javadoc: error - Error - Exception java.lang.ClassNotFoundException thrown while trying to register Taglet net.sf.cdk.tools.doclets.CDKBugTaglet... [javadoc] javadoc: error - Error - Exception java.lang.ClassNotFoundException thrown while trying to register Taglet net.sf.cdk.tools.doclets.CDKDictRefTaglet... [javadoc] javadoc: error - Error - Exception java.lang.ClassNotFoundException thrown while trying to register Taglet net.sf.cdk.tools.doclets.CDKInChITaglet... [javadoc] javadoc: error - Error - Exception java.lang.ClassNotFoundException thrown while trying to register Taglet net.sf.cdk.tools.doclets.CDKThreadSafeTaglet... [javadoc] javadoc: error - Error - Exception java.lang.ClassNotFoundException thrown while trying to register Taglet net.sf.cdk.tools.doclets.CDKThreadNonSafeTaglet... [javadoc] javadoc: error - Error - Exception java.lang.ClassNotFoundException thrown while trying to register Taglet net.sf.cdk.tools.doclets.CDKGitTaglet... [javadoc] Standard Doclet version 1.6.0_15 and then fails with a heap space error ---------------------------------------------------- Rajarshi Guha | NIH Chemical Genomics Center http://www.rguha.net | http://ncgc.nih.gov ---------------------------------------------------- "whois awk?", sed Grep. |