>Setting up Doccheck for Eclipse Plugin Projects

>For those that are interested, here is a small ANT target that can be used as a basis for checking your plugin projects for javadoc errors. These are typically missing comments, no paramaters documented, etc.


<target name="DocCheck">
<javadoc destdir="doc/doccheck" package="true" docletpath="${workspace}/lib/doccheck.jar">
<fileset dir="${workspaceloc}">
<include name="org.eclipse.wst.xsl.core/**/*.java" />
</fileset>
<packageset dir="${workspaceloc}/org.eclipse.wst.xsl.core/src">
<include name="**" />
</packageset>
<doclet name="com.sun.tools.doclets.doccheck.DocCheck">
<param name="-execDepth" value="2" />
</doclet>
</javadoc>
</target>

You can add multiple packagesets and multiple includes. The workspaceloc property refers to the workspace that you have the plugins installed.

Advertisements
This entry was posted in documentation, eclipse. Bookmark the permalink.

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s