How does one set up JavaDoc DocCheck as an Eclipse plugin?

Question

I have recently started using DocCheck for checking the validity of JavaDoc's in code files.

Is there some way to set DocCheck up as an eclipse plugin?

Answer 1

This was deemed a great idea back in 2002, and still asked for in 2004...

But since then, pretty much all the features of the Sun Doc Check Doclet (experimental code developed originally for internal use at Sun and released to the developer community for use as-is) is pretty much covered by the 'Java Compiler / Javadoc' section of the Java project properties (albeit without the HTML rapports outputs)

If you do want to have the DocCheck reports, I would recommend making a custom Project Builder, like this one (not related to DocCheck at all, just here to give you an example)

_{(source: bell-labs.com)}

See also FAQ How do I implement an incremental project builder? or FAQ How do I create an external tool builder?

I would also recommend you set up this custom builder calling DocCheck only when doing a fill build (IncrementalProjectBuilder.FULL_BUILD), in order to avoid to wait each time you save a file.

End users can add external tool builders by selecting a project in the Navigator, choosing Properties, and then going to the Builders page.
On the Build Options tab, you can specify whether the builder should run on autobuild, manual build, or on Clean.
In most cases, running external tool builders during auto-builds is too disruptive because they are too long running.