JavaDoc Sync Plugin 10

The JavaDoc Sync Plugin will assist you to keep your JavaDoc in sync between interface definitions and the implementations, or method definitions and method overrides. The plugin now uses template based generation of JavaDoc, so that the JavaDoc text can now easily be customized to your needs.

The JavaDoc Sync Plugin was originally written by Raymond Brandon but was updated for IntelliJ 8 by woofgl

The JavaDoc Sync Plugin can:

highlight methods that define the @inheritDoc tag but there's no super method

highlight methods that define the @inheritDoc tag but the super method doesn't have javaDoc

highlight a class if one or more methods do not define JavaDoc

Generate JavaDoc for all methods that do not define JavaDoc according to user defined templates

Ignore methods that do not match the configured access modifier level

Ignore overridden methods of anonymous classes or inner classes

highlight methods that do not have JavaDoc

highlight fields that do not have JavaDoc

highlight methods of interface implementations of which the JavaDoc differs from the JavaDoc defined at interface level

highlight overridden methods/constructors of which the JavaDoc differs from the JavaDoc defined in the super classes

When the JavaDoc Sync Plugin detects differences between the defining interface or base method and the implementing or overriding method, the user will get quick fixes presented to update the JavaDoc like:

Copy JavaDoc from parent

Move to parent and introduce reference

Replace parent JavaDoc

Generate JavaDoc from signature

Generate JavaDoc from field

Generate JavaDoc for all methods

To turn on the JavaDoc Sync plugin, go to Settings->Errors and select "JavaDoc issues"